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}
"use strict";
export class ObjectCommunicationSubscriptionDetailModel {
    /** @param {{SubscriptionId?:string,SubscriptionName?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SubscriptionId;
    /** @type {string} */
    SubscriptionName;
    /** @type {string} */
    RecordStatus;
}
export class GetCommunicationSubscriptionsResponse {
    /** @param {{CommunicationSubscriptions?:ObjectCommunicationSubscriptionDetailModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ObjectCommunicationSubscriptionDetailModel[]} */
    CommunicationSubscriptions;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetCommunicationSubscriptions {
    /** @param {{ObjectId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Get object communication subscriptions for the specified object */
    ObjectId;
}

JavaScript 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"}}}