This endpoint returns a list of dependant types for the requested tenant. 


GET    /api/static/dependants/types/get/{tenantId:int}



Request


Url Params

tenantId
int
the id of the tenant


Authorization

The following authorization header is required.  The authorisation header should be set to a 'Bearer Token' type


Token
see How to get a bearer token


Response

The response will return an array of 0 to n JSON objects.  Each JSON object in the array contains the following properties:


idintthe id of the dependant type for the supplied tenant id
tenantId
int
the tenant id associated with the dependant type
dependantTypeIdintthe id of the associated system dependant type
displayName
string
text name of the dependant
orderPriority
string
order priority of the the dependant
inUseboolwhether the dependant type is currently in use on the tenant
limitintCan be used to enforce the max amount of dependants a user can have of this type


Permissions

The API Client requires access to the platform



Examples


C# Example


var client = new HttpClient(); 
var request = new HttpRequestMessage(HttpMethod.Get, "https://{platform API url}/static/dependants/types/get/{tenantId}");
request.Headers.Add("Authorization", "Bearer {access token}"); 
var response = await client.SendAsync(request); 
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());


cURL Example


curl --location 'https://{platform API url}/api/static/dependants/types/get/{tenantId}'
' \ --header 'Authorization: Bearer {access token}'