Platform API

GetLists

Get specified lists and list items

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

**GetLists** Parameters:
Name	Parameter	Data Type	Required	Description
ListIds	query	List<Guid>	No	Get list and list items for the specified list ids

**GetListResponse** Parameters:
Name	Parameter	Data Type	Required	Description
List	form	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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ListIds: 
	[
		00000000-0000-0000-0000-000000000000
	]
}

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

{
	List: 
	{
		Name: String,
		Description: String,
		ShortName: String,
		IsStandard: False,
		RecordStatus: String,
		DefaultListItemName: String,
		HasImageForListItem: False,
		HasTrafficLightForListItem: False,
		ListItems: 
		[
			{
				Name: String,
				Description: String,
				ShortName: String,
				IsDefault: False,
				Order: 0,
				PrimaryListItemImageUrl: String,
				PrimaryImageThumbnailUrl: String,
				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
		}
	}
}