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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get object communication subscriptions for the specified object
    */
    @Api(Description="Get object communication subscriptions for the specified object")
    public static class GetCommunicationSubscriptions
    {
        /**
        * Get object communication subscriptions for the specified object
        */
        @ApiMember(Description="Get object communication subscriptions for the specified object", IsRequired=true, Name="ObjectId")
        public UUID ObjectId = null;
        
        public UUID getObjectId() { return ObjectId; }
        public GetCommunicationSubscriptions setObjectId(UUID value) { this.ObjectId = value; return this; }
    }

    @ApiResponse(Description="List of object communication subscriptions")
    public static class GetCommunicationSubscriptionsResponse
    {
        public ArrayList<ObjectCommunicationSubscriptionDetailModel> CommunicationSubscriptions = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ObjectCommunicationSubscriptionDetailModel> getCommunicationSubscriptions() { return CommunicationSubscriptions; }
        public GetCommunicationSubscriptionsResponse setCommunicationSubscriptions(ArrayList<ObjectCommunicationSubscriptionDetailModel> value) { this.CommunicationSubscriptions = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetCommunicationSubscriptionsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ObjectCommunicationSubscriptionDetailModel
    {
        /**
        * 
        */
        @ApiMember(Description="", Name="SubscriptionId")
        public UUID SubscriptionId = null;

        /**
        * 
        */
        @ApiMember(Description="", Name="SubscriptionName")
        public String SubscriptionName = null;

        /**
        * 
        */
        @ApiMember(Description="", Name="RecordStatus")
        public String RecordStatus = null;
        
        public UUID getSubscriptionId() { return SubscriptionId; }
        public ObjectCommunicationSubscriptionDetailModel setSubscriptionId(UUID value) { this.SubscriptionId = value; return this; }
        public String getSubscriptionName() { return SubscriptionName; }
        public ObjectCommunicationSubscriptionDetailModel setSubscriptionName(String value) { this.SubscriptionName = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public ObjectCommunicationSubscriptionDetailModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

}

Java 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
		}
	}
}