Platform API

GetObjectReads

Get reads (object access) for the specified object.

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

import Foundation
import ServiceStack

/**
* Get reads (object access) for the specified object.
*/
// @Api(Description="Get reads (object access) for the specified object.")
public class GetObjectReads : Codable
{
    /**
    * Object Id to get object access reads for
    */
    // @ApiMember(DataType="Guid", Description="Object Id to get object access reads for", IsRequired=true, Name="ObjectId")
    public var objectId:String

    required public init(){}
}

// @ApiResponse(Description="Returns the reads (object access) to the specified object.")
public class GetObjectReadsResponse : Codable
{
    public var objectReads:[ObjectAccessModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ObjectAccessModel : Codable
{
    /**
    * Object Access Read Id.
    */
    // @ApiMember(Description="Object Access Read Id.", Name="ObjectReadId")
    public var objectReadId:String

    /**
    * Object Id viewing the specified Object.
    */
    // @ApiMember(Description="Object Id viewing the specified Object.", IsRequired=true, Name="ViewingObjectId")
    public var viewingObjectId:String

    /**
    * Name of the object viewing the specified Object.
    */
    // @ApiMember(Description="Name of the object viewing the specified Object.", Name="ViewingObjectName")
    public var viewingObjectName:String

    /**
    * Name of the object viewing the specified Object.
    */
    // @ApiMember(Description="Name of the object viewing the specified Object.", Name="ViewingObjectPrimaryImageUrl")
    public var viewingObjectPrimaryImageUrl:String

    /**
    * Id of the object being viewed.
    */
    // @ApiMember(Description="Id of the object being viewed.", IsRequired=true, Name="ViewedObjectId")
    public var viewedObjectId:String

    /**
    * Name of the object being viewed.
    */
    // @ApiMember(Description="Name of the object being viewed.", Name="ViewedObjectName")
    public var viewedObjectName:String

    /**
    * Date and Time of object read
    */
    // @ApiMember(Description="Date and Time of object read", Name="TimeRead")
    public var timeRead:Date?

    /**
    * Date and Time object started watching the specified object.
    */
    // @ApiMember(Description="Date and Time object started watching the specified object.", Name="TimeStartWatching")
    public var timeStartWatching:Date?

    /**
    * Date and Time of object being flagged.
    */
    // @ApiMember(Description="Date and Time of object being flagged.", Name="Flagged")
    public var flagged:Date

    required public init(){}
}

Swift GetObjectReads DTOs

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>