Platform API

GetObjectSubscriptions

Get object subscriptions for the specified object

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

**GetObjectSubscriptions** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectId	path	Guid	Yes	Get active/inactive object subscriptions for the specified object

**GetObjectSubscriptionsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectSubscriptions	form	List<ObjectSubscriptionDetailModel>	No
ResponseStatus	form	ResponseStatus	No

**ObjectSubscriptionDetailModel** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectSubscriptionId	form	Guid	No	ID for the objectSubscription record.
SuiteDataSourceInstanceId	form	Guid	No	Id of the Suite DataSource Instance Id.
SuiteDataSourceName	form	string	No	Suite DataSource Instance Name.
RmsTableContextId	form	Guid	No	Id indicating the RmsTableCtx of the object.
ObjectId	form	Guid	No	Id of the integrated object.
AlternateKey	form	string	No	Unique Key of this object in the external Data Source.
CreatedAt	form	DateTime	No	Date the object was integrated.
RecordStatus	form	string	No	Record Status of the object subscription.
SuiteInstanceId	form	Guid	No	Id of the Suite Instance.
SuiteInstanceName	form	string	No	Suite Instance Name.

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetObjectSubscriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
</GetObjectSubscriptions>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetObjectSubscriptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ObjectSubscriptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:ObjectSubscriptionDetailModel>
      <d2p1:AlternateKey>String</d2p1:AlternateKey>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
      <d2p1:ObjectSubscriptionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectSubscriptionId>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:RmsTableContextId>00000000-0000-0000-0000-000000000000</d2p1:RmsTableContextId>
      <d2p1:SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</d2p1:SuiteDataSourceInstanceId>
      <d2p1:SuiteDataSourceName>String</d2p1:SuiteDataSourceName>
      <d2p1:SuiteInstanceId>00000000-0000-0000-0000-000000000000</d2p1:SuiteInstanceId>
      <d2p1:SuiteInstanceName>String</d2p1:SuiteInstanceName>
    </d2p1:ObjectSubscriptionDetailModel>
  </ObjectSubscriptions>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetObjectSubscriptionsResponse>