| All Verbs | /api/relateditems/{ObjectId} |
|---|
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
class SortOrder(str, Enum):
ASCENDING = 'Ascending'
DESCENDING = 'Descending'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PagedModel:
# @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
page_number: int = 0
"""
Page Number to retrieve
"""
# @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
page_size: int = 0
"""
Number of records to retrieve
"""
# @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
sort_index: int = 0
"""
Index of field to sort results by
"""
# @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
sort_order: Optional[SortOrder] = None
"""
Sort Order - Ascending or Descending
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RelatedItemsModel:
# @ApiMember(DataType="Guid", Description="Object linked to the related item.", IsRequired=true, Name="ObjectId")
object_id: Optional[str] = None
"""
Object linked to the related item.
"""
# @ApiMember(DataType="string", Description="Related item name.", Name="RelatedItemName")
related_item_name: Optional[str] = None
"""
Related item name.
"""
# @ApiMember(DataType="string", Description="Related item type.", Name="RelatedItemType")
related_item_type: Optional[str] = None
"""
Related item type.
"""
# @ApiMember(DataType="DateTime", Description="Date of creation of the related item.", IsRequired=true, Name="CreatedAt")
created_at: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Date of creation of the related item.
"""
# @ApiMember(DataType="string", Description="Contact who created the related item", Name="CreatedByName")
created_by_name: Optional[str] = None
"""
Contact who created the related item
"""
# @ApiMember(DataType="Guid", Description="Contact who created the related item", Name="CreatedById")
created_by_id: Optional[str] = None
"""
Contact who created the related item
"""
# @ApiMember(DataType="string", Description="Profile photo of the contact who created the related item", Name="CreatedByThumbnailUrl")
created_by_thumbnail_url: Optional[str] = None
"""
Profile photo of the contact who created the related item
"""
# @ApiMember(DataType="string", Description="Relationship between objects linked to the related item", Name="Relationship")
relationship: Optional[str] = None
"""
Relationship between objects linked to the related item
"""
# @ApiMember(DataType="bool", Description="Is the related item significant?", IsRequired=true, Name="IsSignificant")
is_significant: bool = False
"""
Is the related item significant?
"""
# @ApiResponse(Description="Items related to the object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRelatedItemsResponse:
related_items: Optional[List[RelatedItemsModel]] = None
total_related_items: int = 0
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get related items related to the specified object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRelatedItems(PagedModel):
"""
Get related items related to the specified object.
"""
# @ApiMember(Description="Object to get related items for.", IsRequired=true, Name="ObjectId")
object_id: Optional[str] = None
"""
Object to get related items for.
"""
# @ApiMember(Description="Significant Only or All", IsRequired=true, Name="RelatedItemsLevel")
related_items_level: Optional[str] = None
"""
Significant Only or All
"""
# @ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
is_paged_mode: bool = False
"""
Return all connections or paged results?
"""
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.
POST /api/relateditems/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IsPagedMode: False,
PageNumber: 0,
PageSize: 0,
SortIndex: 0,
SortOrder: Ascending
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
RelatedItems:
[
{
RelatedItemName: String,
RelatedItemType: String,
CreatedAt: 0001-01-01,
CreatedByName: String,
CreatedByThumbnailUrl: String,
Relationship: String,
IsSignificant: False
}
],
TotalRelatedItems: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}