Trendsic Platform Service

Clients

**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/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;
}

JavaScript Clients DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<Clients xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Active>false</Active>
  <Address1>String</Address1>
  <Address2>String</Address2>
  <City>String</City>
  <EntDate>0001-01-01T00:00:00</EntDate>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <ModDate>0001-01-01T00:00:00</ModDate>
  <Name>String</Name>
  <State>String</State>
  <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
  <Zip>String</Zip>
  <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</Clients>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClientsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Clients>
    <ClientObject>
      <Active>false</Active>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <City>String</City>
      <EntDate>0001-01-01T00:00:00</EntDate>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ModDate>0001-01-01T00:00:00</ModDate>
      <Name>String</Name>
      <State>String</State>
      <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
      <Zip>String</Zip>
    </ClientObject>
  </Clients>
  <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>
</ClientsResponse>