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}

export class ObjectCommunicationSubscriptionDetailModel
{
    /** @description  */
    // @ApiMember(Description="", Name="SubscriptionId")
    public SubscriptionId: string;

    /** @description  */
    // @ApiMember(Description="", Name="SubscriptionName")
    public SubscriptionName: string;

    /** @description  */
    // @ApiMember(Description="", Name="RecordStatus")
    public RecordStatus: string;

    public constructor(init?: Partial<ObjectCommunicationSubscriptionDetailModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="List of object communication subscriptions")
export class GetCommunicationSubscriptionsResponse
{
    public CommunicationSubscriptions: ObjectCommunicationSubscriptionDetailModel[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetCommunicationSubscriptionsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get object communication subscriptions for the specified object */
// @Api(Description="Get object communication subscriptions for the specified object")
export class GetCommunicationSubscriptions
{
    /** @description Get object communication subscriptions for the specified object */
    // @ApiMember(Description="Get object communication subscriptions for the specified object", IsRequired=true, Name="ObjectId")
    public ObjectId: string;

    public constructor(init?: Partial<GetCommunicationSubscriptions>) { (Object as any).assign(this, init); }
}

TypeScript GetCommunicationSubscriptions DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

{"ObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}