Platform API

GetCommunicationSubscriptions

Get object communication subscriptions for the specified object

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

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ObjectCommunicationSubscriptionDetailModel() = 
        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="", Name="SubscriptionId")>]
        member val SubscriptionId:Guid = new Guid() with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="", Name="SubscriptionName")>]
        member val SubscriptionName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="", Name="RecordStatus")>]
        member val RecordStatus:String = null with get,set

    [<ApiResponse(Description="List of object communication subscriptions")>]
    [<AllowNullLiteral>]
    type GetCommunicationSubscriptionsResponse() = 
        member val CommunicationSubscriptions:ResizeArray<ObjectCommunicationSubscriptionDetailModel> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get object communication subscriptions for the specified object
    ///</summary>
    [<Api(Description="Get object communication subscriptions for the specified object")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ObjectId:Guid = new Guid() with get,set

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

{"CommunicationSubscriptions":[{"SubscriptionId":"00000000-0000-0000-0000-000000000000","SubscriptionName":"String","RecordStatus":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}