Platform API

<back to all web services

GetObjectRateRatings

Get 1 - 5 star object ratings.

Requires Authentication
The following routes are available for this service:
All Verbs/api/lists/ratings/objectrate
GetListItemsResponse Parameters:
NameParameterData TypeRequiredDescription
ListItemsformList<ListItemModel>No
ResponseStatusformResponseStatusNo
ListItemModel Parameters:
NameParameterData TypeRequiredDescription
ListItemIdformGuidNo
NameformstringNo
DescriptionformstringNo
ShortNameformstringNo
IsDefaultformboolNo
OrderformintNo
ListItemTrafficLightIdformGuidNo
PrimaryListItemImageIdformGuidNo
PrimaryListItemImageUrlformstringNo
PrimaryImageThumbnailUrlformstringNo
OwnerContactIdformGuidNo
RecordStatusformstringNo

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/lists/ratings/objectrate HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}