Platform API

GetCommunicationSubscriptions

Get object communication subscriptions for the specified object

The following routes are available for this service:
All Verbs	/api/objectcommunicationsubscriptions/{ObjectId}

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Subtle.Canvara.WebAPIModel.Models

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.Models

        Public Partial Class ObjectCommunicationSubscriptionDetailModel
            '''<Summary>
            '''
            '''</Summary>
            <ApiMember(Description:="", Name:="SubscriptionId")>
            Public Overridable Property SubscriptionId As Guid

            '''<Summary>
            '''
            '''</Summary>
            <ApiMember(Description:="", Name:="SubscriptionName")>
            Public Overridable Property SubscriptionName As String

            '''<Summary>
            '''
            '''</Summary>
            <ApiMember(Description:="", Name:="RecordStatus")>
            Public Overridable Property RecordStatus As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get object communication subscriptions for the specified object
        '''</Summary>
        <Api(Description:="Get object communication subscriptions for the specified object")>
        Public Partial Class GetCommunicationSubscriptions
            '''<Summary>
            '''Get object communication subscriptions for the specified object
            '''</Summary>
            <ApiMember(Description:="Get object communication subscriptions for the specified object", IsRequired:=true, Name:="ObjectId")>
            Public Overridable Property ObjectId As Guid
        End Class

        <ApiResponse(Description:="List of object communication subscriptions")>
        Public Partial Class GetCommunicationSubscriptionsResponse
            Public Overridable Property CommunicationSubscriptions As List(Of ObjectCommunicationSubscriptionDetailModel)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	}
}