| 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 |
export class QueueCustomer
{
public Id: string;
public Name: string;
public Address1: string;
public Address2: string;
public City: string;
public State: string;
public Zip: string;
public MobilePhone: string;
public Email: string;
public MarketingOptIn: string;
public DoNoContact: string;
public EntDate: string;
public ModDate: string;
public constructor(init?: Partial<QueueCustomer>) { (Object as any).assign(this, init); }
}
export class QueueCustomersResponse
{
public ResponseStatus: ResponseStatus;
public Customers: QueueCustomer[] = [];
public constructor(init?: Partial<QueueCustomersResponse>) { (Object as any).assign(this, init); }
}
export class QueueCustomerRequest extends QueueCustomer
{
public ApiKey: string;
public constructor(init?: Partial<QueueCustomerRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript QueueCustomerRequest DTOs
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/Customers/{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,
MobilePhone: String,
Email: String,
MarketingOptIn: 0001-01-01,
DoNoContact: 0001-01-01,
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
}
},
Customers:
[
{
Id: 00000000000000000000000000000000,
Name: String,
Address1: String,
Address2: String,
City: String,
State: String,
Zip: String,
MobilePhone: String,
Email: String,
MarketingOptIn: 0001-01-01,
DoNoContact: 0001-01-01,
EntDate: 0001-01-01,
ModDate: 0001-01-01
}
]
}