| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/Clients/{Id} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Clients |
"use strict";
export class ClientObject {
/** @param {{Id?:string,Name?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,SubscriptionId?:string,Active?:boolean,EntDate?:string,ModDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Name;
/** @type {string} */
Address1;
/** @type {string} */
Address2;
/** @type {string} */
City;
/** @type {string} */
State;
/** @type {string} */
Zip;
/** @type {string} */
SubscriptionId;
/** @type {boolean} */
Active;
/** @type {string} */
EntDate;
/** @type {string} */
ModDate;
}
export class ClientsResponse {
/** @param {{ResponseStatus?:ResponseStatus,Clients?:ClientObject[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {ClientObject[]} */
Clients = [];
}
export class Clients extends ClientObject {
/** @param {{ApiKey?:string,Id?:string,Name?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,SubscriptionId?:string,Active?:boolean,EntDate?:string,ModDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
ApiKey;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Clients/{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,
Address1: String,
Address2: String,
City: String,
State: String,
Zip: String,
SubscriptionId: 00000000000000000000000000000000,
Active: False,
EntDate: 0001-01-01,
ModDate: 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
}
},
Clients:
[
{
Id: 00000000000000000000000000000000,
Name: String,
Address1: String,
Address2: String,
City: String,
State: String,
Zip: String,
SubscriptionId: 00000000000000000000000000000000,
Active: False,
EntDate: 0001-01-01,
ModDate: 0001-01-01
}
]
}