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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class ListItemModel
    {
        public virtual Guid ListItemId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual string ShortName { get; set; }
        public virtual bool IsDefault { get; set; }
        public virtual int Order { get; set; }
        public virtual Guid ListItemTrafficLightId { get; set; }
        public virtual Guid PrimaryListItemImageId { get; set; }
        public virtual string PrimaryListItemImageUrl { get; set; }
        public virtual string PrimaryImageThumbnailUrl { get; set; }
        public virtual Guid OwnerContactId { get; set; }
        public virtual string RecordStatus { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    [ApiResponse(Description="List items for a list")]
    public partial class GetListItemsResponse
    {
        public virtual List<ListItemModel> ListItems { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    ///<summary>
    ///Get 1 - 5 star object ratings.
    ///</summary>
    [Api(Description="Get 1 - 5 star object ratings.")]
    public partial class GetObjectRateRatings
    {
    }

}

C# 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"}}}