| GET | /api/lists | Query for Coruson Lists |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListId | query | Guid | No | Filter by ListId. |
| Name | query | string | No | Filter by the name of the List. |
| Description | query | string | No | Filter by the description of the List. |
| IsSystem | query | BooleanFilter | Yes | Filter Lists depending on if they were created by Coruson or by a user.Allowable Values
|
| IsActive | query | BooleanFilter | Yes | Filter by the List's status.Allowable Values
|
| OrderBy | query | ListOrder | Yes | Property to order by in Ascending order. Default is 'Name'.Allowable Values
|
| OrderByDesc | query | ListOrder | Yes | Property to order by in Descending order.Allowable Values
|
| ThenBy | query | ListOrder | 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 | ListOrder | 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 |
|---|---|---|---|---|
| Lists | form | List<List> | 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 |
|---|---|---|---|---|
| ListId | form | Guid | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| IsSystem | form | bool | No | |
| IsActive | form | bool | No | |
| ListItems | form | List<ListItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListItemId | form | Guid | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| Code | form | string | No | |
| ParentId | form | Guid? | No | |
| ParentName | form | string | No | |
| FullHierarchy | form | string | No | |
| ListId | form | Guid | No | |
| List | form | string | 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/GetLists HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: text/csv
Content-Length: length
{"ListId":"00000000-0000-0000-0000-000000000000","Skip":0,"Version":0,"Name":"String","Take":0,"Description":"String","IsSystem":"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"}],"Lists":[{"Name":"String","Description":"String","IsSystem":false,"IsActive":false,"ListItems":[{"Name":"String","Description":"String","Code":"String","ParentId":"00000000-0000-0000-0000-000000000000","ParentName":"String","FullHierarchy":"String","List":"String","IsActive":false}]}]}