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

export class ListItemModel
{
    public ListItemId: string;
    public Name: string;
    public Description: string;
    public ShortName: string;
    public IsDefault: boolean;
    public Order: number;
    public ListItemTrafficLightId: string;
    public PrimaryListItemImageId: string;
    public PrimaryListItemImageUrl: string;
    public PrimaryImageThumbnailUrl: string;
    public OwnerContactId: string;
    public RecordStatus: string;

    public constructor(init?: Partial<ListItemModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="List items for a list")
export class GetListItemsResponse
{
    public ListItems: ListItemModel[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetListItemsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get 1 - 5 star object ratings. */
// @Api(Description="Get 1 - 5 star object ratings.")
export class GetObjectRateRatings
{

    public constructor(init?: Partial<GetObjectRateRatings>) { (Object as any).assign(this, init); }
}

TypeScript GetObjectRateRatings DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}