| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/Customers/{Id} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Customers |
"use strict";
export class QueueCustomer {
/** @param {{Id?:string,Name?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,MobilePhone?:string,Email?:string,MarketingOptIn?:string,DoNoContact?:string,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} */
MobilePhone;
/** @type {string} */
Email;
/** @type {string} */
MarketingOptIn;
/** @type {string} */
DoNoContact;
/** @type {string} */
EntDate;
/** @type {string} */
ModDate;
}
export class QueueCustomersResponse {
/** @param {{ResponseStatus?:ResponseStatus,Customers?:QueueCustomer[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {QueueCustomer[]} */
Customers = [];
}
export class QueueCustomerRequest extends QueueCustomer {
/** @param {{ApiKey?:string,Id?:string,Name?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,MobilePhone?:string,Email?:string,MarketingOptIn?:string,DoNoContact?:string,EntDate?:string,ModDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
ApiKey;
}
JavaScript QueueCustomerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Customers/{Id} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ApiKey":"00000000000000000000000000000000","Id":"00000000000000000000000000000000","Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","MobilePhone":"String","Email":"String","MarketingOptIn":"0001-01-01T00:00:00.0000000","DoNoContact":"0001-01-01T00:00:00.0000000","EntDate":"0001-01-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Customers":[{"Id":"00000000000000000000000000000000","Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","MobilePhone":"String","Email":"String","MarketingOptIn":"0001-01-01T00:00:00.0000000","DoNoContact":"0001-01-01T00:00:00.0000000","EntDate":"0001-01-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000"}]}