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
"use strict";
export class SubscriptionObject {
    /** @param {{Id?:string,Name?:string,Description?:string,Cost?:number,BeginDate?:string,EndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {number} */
    Cost;
    /** @type {string} */
    BeginDate;
    /** @type {string} */
    EndDate;
}
export class SubscriptionsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Subscriptions?:SubscriptionObject[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SubscriptionObject[]} */
    Subscriptions = [];
}
export class Subscriptions extends SubscriptionObject {
    /** @param {{ApiKey?:string,Id?:string,Name?:string,Description?:string,Cost?:number,BeginDate?:string,EndDate?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    ApiKey;
}

JavaScript Subscriptions DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ApiKey":"00000000000000000000000000000000","Id":"00000000000000000000000000000000","Name":"String","Description":"String","Cost":0,"BeginDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Subscriptions":[{"Id":"00000000000000000000000000000000","Name":"String","Description":"String","Cost":0,"BeginDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000"}]}