| GET | /api/object/{ObjectId}/reads |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ObjectAccessModel:
# @ApiMember(Description="Object Access Read Id.", Name="ObjectReadId")
object_read_id: Optional[str] = None
"""
Object Access Read Id.
"""
# @ApiMember(Description="Object Id viewing the specified Object.", IsRequired=true, Name="ViewingObjectId")
viewing_object_id: Optional[str] = None
"""
Object Id viewing the specified Object.
"""
# @ApiMember(Description="Name of the object viewing the specified Object.", Name="ViewingObjectName")
viewing_object_name: Optional[str] = None
"""
Name of the object viewing the specified Object.
"""
# @ApiMember(Description="Name of the object viewing the specified Object.", Name="ViewingObjectPrimaryImageUrl")
viewing_object_primary_image_url: Optional[str] = None
"""
Name of the object viewing the specified Object.
"""
# @ApiMember(Description="Id of the object being viewed.", IsRequired=true, Name="ViewedObjectId")
viewed_object_id: Optional[str] = None
"""
Id of the object being viewed.
"""
# @ApiMember(Description="Name of the object being viewed.", Name="ViewedObjectName")
viewed_object_name: Optional[str] = None
"""
Name of the object being viewed.
"""
# @ApiMember(Description="Date and Time of object read", Name="TimeRead")
time_read: Optional[datetime.datetime] = None
"""
Date and Time of object read
"""
# @ApiMember(Description="Date and Time object started watching the specified object.", Name="TimeStartWatching")
time_start_watching: Optional[datetime.datetime] = None
"""
Date and Time object started watching the specified object.
"""
# @ApiMember(Description="Date and Time of object being flagged.", Name="Flagged")
flagged: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Date and Time of object being flagged.
"""
# @ApiResponse(Description="Returns the reads (object access) to the specified object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectReadsResponse:
object_reads: Optional[List[ObjectAccessModel]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get reads (object access) for the specified object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectReads:
"""
Get reads (object access) for the specified object.
"""
# @ApiMember(DataType="Guid", Description="Object Id to get object access reads for", IsRequired=true, Name="ObjectId")
object_id: Optional[str] = None
"""
Object Id to get object access reads for
"""
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
}
}
}