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 .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.

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

{"ListItemFilters":[{"ListItemFilterId":"00000000-0000-0000-0000-000000000000","FilterName":"String","ListId":"00000000-0000-0000-0000-000000000000","ListItemId":"00000000-0000-0000-0000-000000000000","ListItemIsInFilter":false}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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