Platform API

GetListItemsForList

Get list items of the specified data list

The following routes are available for this service:
All Verbs	/api/datalist/items/{DataListId}

**GetListItemsForList** Parameters:
Name	Parameter	Data Type	Required	Description
DataListId	path	Guid	No	The Data List Guid. Records retrieved will belong to this data list.

**GetListItemsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ListItems	form	List<ListItemModel>	No
ResponseStatus	form	ResponseStatus	No

**ListItemModel** Parameters:
Name	Parameter	Data Type	Required
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 .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/datalist/items/{DataListId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"DataListId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"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"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}