Platform API

<back to all web services

GetCommunicationSubscriptions

Get object communication subscriptions for the specified object

Requires Authentication
The following routes are available for this service:
All Verbs/api/objectcommunicationsubscriptions/{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 ObjectCommunicationSubscriptionDetailModel
    {
        ///<summary>
        ///
        ///</summary>
        [ApiMember(Description="", Name="SubscriptionId")]
        public virtual Guid SubscriptionId { get; set; }

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

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

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get object communication subscriptions for the specified object
    ///</summary>
    [Api(Description="Get object communication subscriptions for the specified object")]
    public partial class GetCommunicationSubscriptions
    {
        ///<summary>
        ///Get object communication subscriptions for the specified object
        ///</summary>
        [ApiMember(Description="Get object communication subscriptions for the specified object", IsRequired=true, Name="ObjectId")]
        public virtual Guid ObjectId { get; set; }
    }

    [ApiResponse(Description="List of object communication subscriptions")]
    public partial class GetCommunicationSubscriptionsResponse
    {
        public virtual List<ObjectCommunicationSubscriptionDetailModel> CommunicationSubscriptions { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetCommunicationSubscriptions 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/objectcommunicationsubscriptions/{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

{
	CommunicationSubscriptions: 
	[
		{
			SubscriptionName: String,
			RecordStatus: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}