Trendsic Platform Service

<back to all web services

AddressRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/getAddress/{AddressID}
"use strict";
export class Address {
    /** @param {{ID?:number,AddressTypeID?:number,AddressContact?:string,AttentionTo?:string,AddressLine1?:string,AddressLine2?:string,AddressLine3?:string,AddressCity?:string,AddressState?:string,AddressZip?:string,AddressCountry?:string,PhoneNumber?:string,FaxNumber?:string,UID?:string,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {number} */
    AddressTypeID;
    /** @type {string} */
    AddressContact;
    /** @type {string} */
    AttentionTo;
    /** @type {string} */
    AddressLine1;
    /** @type {string} */
    AddressLine2;
    /** @type {string} */
    AddressLine3;
    /** @type {string} */
    AddressCity;
    /** @type {string} */
    AddressState;
    /** @type {string} */
    AddressZip;
    /** @type {string} */
    AddressCountry;
    /** @type {string} */
    PhoneNumber;
    /** @type {string} */
    FaxNumber;
    /** @type {string} */
    UID;
    /** @type {string} */
    Name;
}
export class AddressResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Address?:Address}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Address} */
    Address;
}
export class AddressRequest {
    /** @param {{AddressID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AddressID;
}

JavaScript AddressRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/getAddress/{AddressID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Address: 
	{
		ID: 0,
		AddressTypeID: 0,
		AddressContact: String,
		AttentionTo: String,
		AddressLine1: String,
		AddressLine2: String,
		AddressLine3: String,
		AddressCity: String,
		AddressState: String,
		AddressZip: String,
		AddressCountry: String,
		PhoneNumber: String,
		FaxNumber: String,
		UID: 00000000000000000000000000000000,
		Name: String
	}
}