Platform API

<back to all web services

SaveListItemFilters

Save filtered list items

Requires Authentication
The following routes are available for this service:
PUT/api/listItems/filters
SaveListItemFilters Parameters:
NameParameterData TypeRequiredDescription
ListItemFiltersbodyList<ListItemFilterModel>No
ListItemFilterModel Parameters:
NameParameterData TypeRequiredDescription
ListItemFilterIdformGuidNo
FilterNameformstringNo
ListIdformGuidNo
ListItemIdformGuidNo
ListItemIsInFilterformboolNo
SaveListItemFiltersResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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.

PUT /api/listItems/filters HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ListItemFilters: 
	[
		{
			FilterName: String,
			ListItemIsInFilter: False
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}