Platform API

GetObjectReads

Get reads (object access) for the specified object.

The following routes are available for this service:
GET	/api/object/{ObjectId}/reads

**GetObjectReads** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectId	path	Guid	Yes	Object Id to get object access reads for

**GetObjectReadsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectReads	form	List<ObjectAccessModel>	No
ResponseStatus	form	ResponseStatus	No

**ObjectAccessModel** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectReadId	form	Guid	No	Object Access Read Id.
ViewingObjectId	form	Guid	Yes	Object Id viewing the specified Object.
ViewingObjectName	form	string	No	Name of the object viewing the specified Object.
ViewingObjectPrimaryImageUrl	form	string	No	Name of the object viewing the specified Object.
ViewedObjectId	form	Guid	Yes	Id of the object being viewed.
ViewedObjectName	form	string	No	Name of the object being viewed.
TimeRead	form	DateTime?	No	Date and Time of object read
TimeStartWatching	form	DateTime?	No	Date and Time object started watching the specified object.
Flagged	form	DateTime	No	Date and Time of object being flagged.

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/object/{ObjectId}/reads HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetObjectReadsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ObjectReads xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ObjectAccessModel>
      <d2p1:Flagged>0001-01-01T00:00:00</d2p1:Flagged>
      <d2p1:ObjectReadId>00000000-0000-0000-0000-000000000000</d2p1:ObjectReadId>
      <d2p1:TimeRead>0001-01-01T00:00:00</d2p1:TimeRead>
      <d2p1:TimeStartWatching>0001-01-01T00:00:00</d2p1:TimeStartWatching>
      <d2p1:ViewedObjectId>00000000-0000-0000-0000-000000000000</d2p1:ViewedObjectId>
      <d2p1:ViewedObjectName>String</d2p1:ViewedObjectName>
      <d2p1:ViewingObjectId>00000000-0000-0000-0000-000000000000</d2p1:ViewingObjectId>
      <d2p1:ViewingObjectName>String</d2p1:ViewingObjectName>
      <d2p1:ViewingObjectPrimaryImageUrl>String</d2p1:ViewingObjectPrimaryImageUrl>
    </d2p1:ObjectAccessModel>
  </ObjectReads>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetObjectReadsResponse>