| All Verbs | /api/lists/ |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListIds | query | List<Guid> | No | Get list and list items for the specified list ids |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| List | form | ListModel | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListId | form | Guid | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| ShortName | form | string | No | |
| OwnerContactId | form | Guid | No | |
| IsStandard | form | bool | No | |
| RecordStatus | form | string | No | |
| DefaultListItemId | form | Guid | No | |
| DefaultListItemName | form | string | No | |
| HasImageForListItem | form | bool | No | |
| HasTrafficLightForListItem | form | bool | No | |
| ListItems | form | List<ListItemModel> | No | |
| PermissionEdit | form | bool | No | |
| PermissionAdd | form | bool | No | |
| PermissionDelete | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListItemId | form | Guid | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| ShortName | form | string | No | |
| IsDefault | form | bool | No | |
| Order | form | int | No | |
| ListItemTrafficLightId | form | Guid | No | |
| PrimaryListItemImageId | form | Guid | No | |
| PrimaryListItemImageUrl | form | string | No | |
| PrimaryImageThumbnailUrl | form | string | No | |
| OwnerContactId | form | Guid | No | |
| RecordStatus | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/lists/ HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ListIds":["00000000-0000-0000-0000-000000000000"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"List":{"ListId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","IsStandard":false,"RecordStatus":"String","DefaultListItemId":"00000000-0000-0000-0000-000000000000","DefaultListItemName":"String","HasImageForListItem":false,"HasTrafficLightForListItem":false,"ListItems":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}],"PermissionEdit":false,"PermissionAdd":false,"PermissionDelete":false},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}