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 Foundation
import ServiceStack

public class Subscriptions : SubscriptionObject
{
    public var apiKey:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case apiKey
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        apiKey = try container.decodeIfPresent(String.self, forKey: .apiKey)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if apiKey != nil { try container.encode(apiKey, forKey: .apiKey) }
    }
}

public class SubscriptionObject : Codable
{
    public var id:String
    public var name:String
    public var Description:String
    public var cost:Double
    public var beginDate:Date
    public var endDate:Date

    required public init(){}
}

public class SubscriptionsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var subscriptions:[SubscriptionObject] = []

    required public init(){}
}


Swift 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>