| GET | /api/object/{ObjectId}/reads |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectId | path | Guid | Yes | Object Id to get object access reads for |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectReads | form | List<ObjectAccessModel> | No | |
| ResponseStatus | form | ResponseStatus | No |
| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ObjectReads:
[
{
ViewingObjectName: String,
ViewingObjectPrimaryImageUrl: String,
ViewedObjectName: String,
TimeRead: 0001-01-01,
TimeStartWatching: 0001-01-01,
Flagged: 0001-01-01
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}