Trendsic Platform Service

<back to all web services

LocationsRequest

Requires Authentication
Required roles:Administrator, Administrator, AdministratorRequires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Locations/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/Locations
"use strict";
export class Location {
    /** @param {{Id?:string,ClientId?:string,Name?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Phone?:string,Fax?:string,TimeZone?:string,Active?:boolean,EntDate?:string,ModDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    ClientId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Fax;
    /** @type {string} */
    TimeZone;
    /** @type {boolean} */
    Active;
    /** @type {string} */
    EntDate;
    /** @type {string} */
    ModDate;
}
export class LocationsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Locations?:Location[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Location[]} */
    Locations = [];
}
export class LocationsRequest {
    /** @param {{Id?:string,Locations?:Location[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {Location[]} */
    Locations = [];
}

JavaScript LocationsRequest 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/Locations/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LocationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Locations>
    <Location>
      <Active>false</Active>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <City>String</City>
      <ClientId>00000000-0000-0000-0000-000000000000</ClientId>
      <EntDate>0001-01-01T00:00:00</EntDate>
      <Fax>String</Fax>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ModDate>0001-01-01T00:00:00</ModDate>
      <Name>String</Name>
      <Phone>String</Phone>
      <State>String</State>
      <TimeZone>String</TimeZone>
      <Zip>String</Zip>
    </Location>
  </Locations>
</LocationsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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