Platform API

<back to all web services

GetCommunicationSubscriptions

Get object communication subscriptions for the specified object

Requires Authentication
The following routes are available for this service:
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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"ObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CommunicationSubscriptions":[{"SubscriptionId":"00000000-0000-0000-0000-000000000000","SubscriptionName":"String","RecordStatus":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}