GET | /api/orgunits | Query for Coruson Organisational Units |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrgUnitId | query | Guid | No | Filter by OrgUnitId. |
Name | query | string | No | Filter by the name of the Org Unit. |
Code | query | string | No | Filter by the code of the Org Unit. |
Description | query | string | No | Filter by the description of the Org Unit. |
ParentId | query | Guid | No | Filter by the parent OrgUnitId of the Org Unit. |
ParentName | query | string | No | Filter by the name of the parent the Org Unit(s) belongs to. |
FullHierarchy | query | string | No | Filter organisational units by providing their full hierarchy. Format should be: {Root}\\\\..\\\\..\\\\{Parent}. |
IsDefault | query | BooleanFilter | Yes | Filter by the default Org Unit. Only one Org Unit is default.Allowable Values
|
IsActive | query | BooleanFilter | Yes | Filter by the Org Unit status.Allowable Values
|
OrderBy | query | OrgUnitOrder | Yes | Property to order by in Ascending order. Default is 'Name'.Allowable Values
|
OrderByDesc | query | OrgUnitOrder | Yes | Property to order by in Descending order.Allowable Values
|
ThenBy | query | OrgUnitOrder | Yes | Second Property to order by in Ascending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.Allowable Values
|
ThenByDesc | query | OrgUnitOrder | Yes | Second Property to order by in Descending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.Allowable Values
|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | Integer | No | Number of items to skip before returning results. Minimum suitable value is 0 and is also the default value. |
Take | form | Integer | No | Number of items to return per page. Must be a number in the range 1-100. Default value is 100. |
OrderBy | form | Enum | No | Order By |
OrderByDesc | form | Enum | No | Order By Descending |
ThenBy | form | Enum | No | Then By |
ThenByDesc | form | Enum | No | Then By Descending |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Version | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrgUnits | form | List<OrgUnit> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalResults | form | int | No | |
Skip | form | int | No | |
Take | form | int | No | |
Links | form | List<Link> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StatusDescription | form | string | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
RequestUrl | form | string | No | |
Method | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrgUnitId | form | Guid | No | |
Name | form | string | No | |
Code | form | string | No | |
Description | form | string | No | |
ParentId | form | Guid? | No | |
ParentName | form | string | No | |
FullHierarchy | form | string | No | |
IsDefault | form | bool | No | |
IsActive | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/GetOrgUnits HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: text/csv
Content-Length: length
{"OrgUnitId":"00000000-0000-0000-0000-000000000000","Skip":0,"Version":0,"Name":"String","Take":0,"Code":"String","Description":"String","ParentId":"00000000-0000-0000-0000-000000000000","ParentName":"String","FullHierarchy":"String","IsDefault":"All","IsActive":"All","OrderBy":"Default","OrderByDesc":"Default","ThenBy":"Default","ThenByDesc":"Default"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"TotalResults":0,"StatusDescription":"String","Skip":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Take":0,"Links":[{"Name":"String","RequestUrl":"String","Method":"String"}],"OrgUnits":[{"Name":"String","Code":"String","Description":"String","ParentId":"00000000-0000-0000-0000-000000000000","ParentName":"String","FullHierarchy":"String","IsDefault":false,"IsActive":false}]}