Trendsic Platform Service

<back to all web services

Subscriptions

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Subscriptions/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/Subscriptions
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class SubscriptionObject implements IConvertible
{
    String? Id;
    String? Name;
    String? Description;
    double? Cost;
    DateTime? BeginDate;
    DateTime? EndDate;

    SubscriptionObject({this.Id,this.Name,this.Description,this.Cost,this.BeginDate,this.EndDate});
    SubscriptionObject.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        Description = json['Description'];
        Cost = JsonConverters.toDouble(json['Cost']);
        BeginDate = JsonConverters.fromJson(json['BeginDate'],'DateTime',context!);
        EndDate = JsonConverters.fromJson(json['EndDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'Description': Description,
        'Cost': Cost,
        'BeginDate': JsonConverters.toJson(BeginDate,'DateTime',context!),
        'EndDate': JsonConverters.toJson(EndDate,'DateTime',context!)
    };

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

class SubscriptionsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<SubscriptionObject>? Subscriptions = [];

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

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

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

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

class Subscriptions extends SubscriptionObject implements IConvertible
{
    String? ApiKey;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ApiKey': ApiKey
    });

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'SubscriptionObject': TypeInfo(TypeOf.Class, create:() => SubscriptionObject()),
    'SubscriptionsResponse': TypeInfo(TypeOf.Class, create:() => SubscriptionsResponse()),
    'List<SubscriptionObject>': TypeInfo(TypeOf.Class, create:() => <SubscriptionObject>[]),
    'Subscriptions': TypeInfo(TypeOf.Class, create:() => Subscriptions()),
});

Dart Subscriptions 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 /v1/Subscriptions/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Subscriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BeginDate>0001-01-01T00:00:00</BeginDate>
  <Cost>0</Cost>
  <Description>String</Description>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Name>String</Name>
  <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</Subscriptions>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SubscriptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Subscriptions>
    <SubscriptionObject>
      <BeginDate>0001-01-01T00:00:00</BeginDate>
      <Cost>0</Cost>
      <Description>String</Description>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Name>String</Name>
    </SubscriptionObject>
  </Subscriptions>
</SubscriptionsResponse>