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

export class SubscriptionObject
{
    public Id: string;
    public Name: string;
    public Description: string;
    public Cost: number;
    public BeginDate: string;
    public EndDate: string;

    public constructor(init?: Partial<SubscriptionObject>) { (Object as any).assign(this, init); }
}

export class SubscriptionsResponse
{
    public ResponseStatus: ResponseStatus;
    public Subscriptions: SubscriptionObject[] = [];

    public constructor(init?: Partial<SubscriptionsResponse>) { (Object as any).assign(this, init); }
}

export class Subscriptions extends SubscriptionObject
{
    public ApiKey: string;

    public constructor(init?: Partial<Subscriptions>) { super(init); (Object as any).assign(this, init); }
}

TypeScript Subscriptions DTOs

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

HTTP + JSV

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

{
	ApiKey: 00000000000000000000000000000000,
	Id: 00000000000000000000000000000000,
	Name: String,
	Description: String,
	Cost: 0,
	BeginDate: 0001-01-01,
	EndDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			EndDate: 0001-01-01
		}
	]
}