Platform API

GetObjectSubscriptions

Get object subscriptions for the specified object

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

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

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"ObjectId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ObjectSubscriptions":[{"ObjectSubscriptionId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceInstanceId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceName":"String","RmsTableContextId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","AlternateKey":"String","CreatedAt":"0001-01-01T00:00:00.0000000","RecordStatus":"String","SuiteInstanceId":"00000000-0000-0000-0000-000000000000","SuiteInstanceName":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}