Platform API

GetCommunicationSubscriptions

Get object communication subscriptions for the specified object

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

import 'package:servicestack/servicestack.dart';

class ObjectCommunicationSubscriptionDetailModel implements IConvertible
{
    /**
    * 
    */
    // @ApiMember(Description="", Name="SubscriptionId")
    String? SubscriptionId;

    /**
    * 
    */
    // @ApiMember(Description="", Name="SubscriptionName")
    String? SubscriptionName;

    /**
    * 
    */
    // @ApiMember(Description="", Name="RecordStatus")
    String? RecordStatus;

    ObjectCommunicationSubscriptionDetailModel({this.SubscriptionId,this.SubscriptionName,this.RecordStatus});
    ObjectCommunicationSubscriptionDetailModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SubscriptionId = json['SubscriptionId'];
        SubscriptionName = json['SubscriptionName'];
        RecordStatus = json['RecordStatus'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SubscriptionId': SubscriptionId,
        'SubscriptionName': SubscriptionName,
        'RecordStatus': RecordStatus
    };

    getTypeName() => "ObjectCommunicationSubscriptionDetailModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="List of object communication subscriptions")
class GetCommunicationSubscriptionsResponse implements IConvertible
{
    List<ObjectCommunicationSubscriptionDetailModel>? CommunicationSubscriptions;
    ResponseStatus? ResponseStatus;

    GetCommunicationSubscriptionsResponse({this.CommunicationSubscriptions,this.ResponseStatus});
    GetCommunicationSubscriptionsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CommunicationSubscriptions = JsonConverters.fromJson(json['CommunicationSubscriptions'],'List<ObjectCommunicationSubscriptionDetailModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CommunicationSubscriptions': JsonConverters.toJson(CommunicationSubscriptions,'List<ObjectCommunicationSubscriptionDetailModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetCommunicationSubscriptionsResponse";
    TypeContext? context = _ctx;
}

/**
* Get object communication subscriptions for the specified object
*/
// @Api(Description="Get object communication subscriptions for the specified object")
class GetCommunicationSubscriptions implements IConvertible
{
    /**
    * Get object communication subscriptions for the specified object
    */
    // @ApiMember(Description="Get object communication subscriptions for the specified object", IsRequired=true, Name="ObjectId")
    String? ObjectId;

    GetCommunicationSubscriptions({this.ObjectId});
    GetCommunicationSubscriptions.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ObjectId = json['ObjectId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ObjectId': ObjectId
    };

    getTypeName() => "GetCommunicationSubscriptions";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'ObjectCommunicationSubscriptionDetailModel': TypeInfo(TypeOf.Class, create:() => ObjectCommunicationSubscriptionDetailModel()),
    'GetCommunicationSubscriptionsResponse': TypeInfo(TypeOf.Class, create:() => GetCommunicationSubscriptionsResponse()),
    'List<ObjectCommunicationSubscriptionDetailModel>': TypeInfo(TypeOf.Class, create:() => <ObjectCommunicationSubscriptionDetailModel>[]),
    'GetCommunicationSubscriptions': TypeInfo(TypeOf.Class, create:() => GetCommunicationSubscriptions()),
});

Dart GetCommunicationSubscriptions DTOs

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/objectcommunicationsubscriptions/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetCommunicationSubscriptions 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>
</GetCommunicationSubscriptions>

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

<GetCommunicationSubscriptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <CommunicationSubscriptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:ObjectCommunicationSubscriptionDetailModel>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:SubscriptionId>00000000-0000-0000-0000-000000000000</d2p1:SubscriptionId>
      <d2p1:SubscriptionName>String</d2p1:SubscriptionName>
    </d2p1:ObjectCommunicationSubscriptionDetailModel>
  </CommunicationSubscriptions>
  <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>
</GetCommunicationSubscriptionsResponse>