Platform API

GetObjectSubscriptions

Get object subscriptions for the specified object

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

import Foundation
import ServiceStack

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

    required public init(){}
}

// @ApiResponse(Description="List of object subscriptions")
public class GetObjectSubscriptionsResponse : Codable
{
    public var objectSubscriptions:[ObjectSubscriptionDetailModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ObjectSubscriptionDetailModel : Codable
{
    /**
    * ID for the objectSubscription record.
    */
    // @ApiMember(Description="ID for the objectSubscription record.", Name="ObjectSubscriptionId")
    public var objectSubscriptionId:String

    /**
    * Id of the Suite DataSource Instance Id.
    */
    // @ApiMember(Description="Id of the Suite DataSource Instance Id.", Name="SuiteDataSourceInstanceId")
    public var suiteDataSourceInstanceId:String

    /**
    * Suite DataSource Instance Name.
    */
    // @ApiMember(Description="Suite DataSource Instance Name.", Name="SuiteDataSourceName")
    public var suiteDataSourceName:String

    /**
    * Id indicating the RmsTableCtx of the object.
    */
    // @ApiMember(Description="Id indicating the RmsTableCtx of the object.", Name="RmsTableContextId")
    public var rmsTableContextId:String

    /**
    * Id of the integrated object.
    */
    // @ApiMember(Description="Id of the integrated object.", Name="ObjectId")
    public var objectId:String

    /**
    * Unique Key of this object in the external Data Source.
    */
    // @ApiMember(Description="Unique Key of this object in the external Data Source.", Name="AlternateKey")
    public var alternateKey:String

    /**
    * Date the object was integrated.
    */
    // @ApiMember(Description="Date the object was integrated.", Name="CreatedAt")
    public var createdAt:Date

    /**
    * Record Status of the object subscription.
    */
    // @ApiMember(Description="Record Status of the object subscription.", Name="RecordStatus")
    public var recordStatus:String

    /**
    * Id of the Suite Instance.
    */
    // @ApiMember(Description="Id of the Suite Instance.", Name="SuiteInstanceId")
    public var suiteInstanceId:String

    /**
    * Suite Instance Name.
    */
    // @ApiMember(Description="Suite Instance Name.", Name="SuiteInstanceName")
    public var suiteInstanceName:String

    required public init(){}
}

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