| All Verbs | /api/objectcommunicationsubscriptions/{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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ObjectCommunicationSubscriptionDetailModel:
# @ApiMember(Description="", Name="SubscriptionId")
subscription_id: Optional[str] = None
"""
"""
# @ApiMember(Description="", Name="SubscriptionName")
subscription_name: Optional[str] = None
"""
"""
# @ApiMember(Description="", Name="RecordStatus")
record_status: Optional[str] = None
"""
"""
# @ApiResponse(Description="List of object communication subscriptions")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCommunicationSubscriptionsResponse:
communication_subscriptions: Optional[List[ObjectCommunicationSubscriptionDetailModel]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get object communication subscriptions for the specified object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCommunicationSubscriptions:
"""
Get object communication subscriptions for the specified object
"""
# @ApiMember(Description="Get object communication subscriptions for the specified object", IsRequired=true, Name="ObjectId")
object_id: Optional[str] = None
"""
Get object communication subscriptions for the specified object
"""
Python GetCommunicationSubscriptions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/objectcommunicationsubscriptions/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetCommunicationSubscriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
</GetCommunicationSubscriptions>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetCommunicationSubscriptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<CommunicationSubscriptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
<d2p1:ObjectCommunicationSubscriptionDetailModel>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:SubscriptionId>00000000-0000-0000-0000-000000000000</d2p1:SubscriptionId>
<d2p1:SubscriptionName>String</d2p1:SubscriptionName>
</d2p1:ObjectCommunicationSubscriptionDetailModel>
</CommunicationSubscriptions>
<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>
</GetCommunicationSubscriptionsResponse>