Platform API

<back to all web services

GetObjectSubscriptions

Get object subscriptions for the specified object

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

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 virtual Guid ObjectSubscriptionId { get; set; }

        ///<summary>
        ///Id of the Suite DataSource Instance Id.
        ///</summary>
        [ApiMember(Description="Id of the Suite DataSource Instance Id.", Name="SuiteDataSourceInstanceId")]
        public virtual Guid SuiteDataSourceInstanceId { get; set; }

        ///<summary>
        ///Suite DataSource Instance Name.
        ///</summary>
        [ApiMember(Description="Suite DataSource Instance Name.", Name="SuiteDataSourceName")]
        public virtual string SuiteDataSourceName { get; set; }

        ///<summary>
        ///Id indicating the RmsTableCtx of the object.
        ///</summary>
        [ApiMember(Description="Id indicating the RmsTableCtx of the object.", Name="RmsTableContextId")]
        public virtual Guid RmsTableContextId { get; set; }

        ///<summary>
        ///Id of the integrated object.
        ///</summary>
        [ApiMember(Description="Id of the integrated object.", Name="ObjectId")]
        public virtual Guid ObjectId { get; set; }

        ///<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 virtual string AlternateKey { get; set; }

        ///<summary>
        ///Date the object was integrated.
        ///</summary>
        [ApiMember(Description="Date the object was integrated.", Name="CreatedAt")]
        public virtual DateTime CreatedAt { get; set; }

        ///<summary>
        ///Record Status of the object subscription.
        ///</summary>
        [ApiMember(Description="Record Status of the object subscription.", Name="RecordStatus")]
        public virtual string RecordStatus { get; set; }

        ///<summary>
        ///Id of the Suite Instance.
        ///</summary>
        [ApiMember(Description="Id of the Suite Instance.", Name="SuiteInstanceId")]
        public virtual Guid SuiteInstanceId { get; set; }

        ///<summary>
        ///Suite Instance Name.
        ///</summary>
        [ApiMember(Description="Suite Instance Name.", Name="SuiteInstanceName")]
        public virtual string SuiteInstanceName { get; set; }
    }

}

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 virtual Guid ObjectId { get; set; }
    }

    [ApiResponse(Description="List of object subscriptions")]
    public partial class GetObjectSubscriptionsResponse
    {
        public virtual List<ObjectSubscriptionDetailModel> ObjectSubscriptions { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetObjectSubscriptions DTOs

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>