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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"Id":"00000000000000000000000000000000","Locations":[{"Id":"00000000000000000000000000000000","ClientId":"00000000000000000000000000000000","Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Phone":"String","Fax":"String","TimeZone":"String","Active":false,"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"}},"Locations":[{"Id":"00000000000000000000000000000000","ClientId":"00000000000000000000000000000000","Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Phone":"String","Fax":"String","TimeZone":"String","Active":false,"EntDate":"0001-01-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000"}]}