| 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<QueueCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Address1>String</Address1>
<Address2>String</Address2>
<City>String</City>
<DoNoContact>0001-01-01T00:00:00</DoNoContact>
<Email>String</Email>
<EntDate>0001-01-01T00:00:00</EntDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
<MarketingOptIn>0001-01-01T00:00:00</MarketingOptIn>
<MobilePhone>String</MobilePhone>
<ModDate>0001-01-01T00:00:00</ModDate>
<Name>String</Name>
<State>String</State>
<Zip>String</Zip>
<ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</QueueCustomerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueueCustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Customers>
<QueueCustomer>
<Address1>String</Address1>
<Address2>String</Address2>
<City>String</City>
<DoNoContact>0001-01-01T00:00:00</DoNoContact>
<Email>String</Email>
<EntDate>0001-01-01T00:00:00</EntDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
<MarketingOptIn>0001-01-01T00:00:00</MarketingOptIn>
<MobilePhone>String</MobilePhone>
<ModDate>0001-01-01T00:00:00</ModDate>
<Name>String</Name>
<State>String</State>
<Zip>String</Zip>
</QueueCustomer>
</Customers>
<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>
</QueueCustomersResponse>