| All Verbs | /api/listitems/{ListItemId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListItemId | query | Guid | Yes | List item id to retrieve details for |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListItem | form | ListItemModel | No | |
| ResponseStatus | form | ResponseStatus | 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/listitems/{ListItemId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ListItemId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ListItem":{"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"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}