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 Foundation
import ServiceStack

/**
* Get object communication subscriptions for the specified object
*/
// @Api(Description="Get object communication subscriptions for the specified object")
public class GetCommunicationSubscriptions : Codable
{
    /**
    * Get object communication subscriptions for the specified object
    */
    // @ApiMember(Description="Get object communication subscriptions for the specified object", IsRequired=true, Name="ObjectId")
    public var objectId:String

    required public init(){}
}

// @ApiResponse(Description="List of object communication subscriptions")
public class GetCommunicationSubscriptionsResponse : Codable
{
    public var communicationSubscriptions:[ObjectCommunicationSubscriptionDetailModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ObjectCommunicationSubscriptionDetailModel : Codable
{
    /**
    * 
    */
    // @ApiMember(Description="", Name="SubscriptionId")
    public var subscriptionId:String

    /**
    * 
    */
    // @ApiMember(Description="", Name="SubscriptionName")
    public var subscriptionName:String

    /**
    * 
    */
    // @ApiMember(Description="", Name="RecordStatus")
    public var recordStatus:String

    required public init(){}
}


Swift GetCommunicationSubscriptions DTOs

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

HTTP + JSV

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

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CommunicationSubscriptions: 
	[
		{
			SubscriptionName: String,
			RecordStatus: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}