Platform API

GetDataLists

Get custom data lists for a licensee, as well as standard data lists

The following routes are available for this service:
All Verbs	/api/datalists/

**GetDataLists** Parameters:
Name	Parameter	Data Type	Required	Description
LicenseeId	query	Guid?	No	Licensee requested Custom data lists belong to.
SearchText	query	string	No	Specific text to search for.

**GetDataListsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Lists	form	List<ListModel>	No
ResponseStatus	form	ResponseStatus	No

**ListModel** Parameters:
Name	Parameter	Data Type	Required
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

**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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /api/datalists/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"LicenseeId":"00000000000000000000000000000000","SearchText":"String"}

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

{"Lists":[{"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"}}}