Platform API

GetObjectSubscriptions

Get object subscriptions for the specified object

The following routes are available for this service:
All Verbs	/api/objectsubscriptions/{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 ObjectSubscriptionDetailModel
            '''<Summary>
            '''ID for the objectSubscription record.
            '''</Summary>
            <ApiMember(Description:="ID for the objectSubscription record.", Name:="ObjectSubscriptionId")>
            Public Overridable Property ObjectSubscriptionId As Guid

            '''<Summary>
            '''Id of the Suite DataSource Instance Id.
            '''</Summary>
            <ApiMember(Description:="Id of the Suite DataSource Instance Id.", Name:="SuiteDataSourceInstanceId")>
            Public Overridable Property SuiteDataSourceInstanceId As Guid

            '''<Summary>
            '''Suite DataSource Instance Name.
            '''</Summary>
            <ApiMember(Description:="Suite DataSource Instance Name.", Name:="SuiteDataSourceName")>
            Public Overridable Property SuiteDataSourceName As String

            '''<Summary>
            '''Id indicating the RmsTableCtx of the object.
            '''</Summary>
            <ApiMember(Description:="Id indicating the RmsTableCtx of the object.", Name:="RmsTableContextId")>
            Public Overridable Property RmsTableContextId As Guid

            '''<Summary>
            '''Id of the integrated object.
            '''</Summary>
            <ApiMember(Description:="Id of the integrated object.", Name:="ObjectId")>
            Public Overridable Property ObjectId As Guid

            '''<Summary>
            '''Unique Key of this object in the external Data Source.
            '''</Summary>
            <ApiMember(Description:="Unique Key of this object in the external Data Source.", Name:="AlternateKey")>
            Public Overridable Property AlternateKey As String

            '''<Summary>
            '''Date the object was integrated.
            '''</Summary>
            <ApiMember(Description:="Date the object was integrated.", Name:="CreatedAt")>
            Public Overridable Property CreatedAt As Date

            '''<Summary>
            '''Record Status of the object subscription.
            '''</Summary>
            <ApiMember(Description:="Record Status of the object subscription.", Name:="RecordStatus")>
            Public Overridable Property RecordStatus As String

            '''<Summary>
            '''Id of the Suite Instance.
            '''</Summary>
            <ApiMember(Description:="Id of the Suite Instance.", Name:="SuiteInstanceId")>
            Public Overridable Property SuiteInstanceId As Guid

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

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

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

        <ApiResponse(Description:="List of object subscriptions")>
        Public Partial Class GetObjectSubscriptionsResponse
            Public Overridable Property ObjectSubscriptions As List(Of ObjectSubscriptionDetailModel)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetObjectSubscriptions 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/objectsubscriptions/{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

{
	ObjectSubscriptions: 
	[
		{
			SuiteDataSourceName: String,
			AlternateKey: String,
			CreatedAt: 0001-01-01,
			RecordStatus: String,
			SuiteInstanceName: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}