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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class LocationsRequest
{
    open var Id:UUID? = null
    open var Locations:ArrayList<Location> = ArrayList<Location>()
}

open class Location
{
    open var Id:UUID? = null
    open var ClientId:UUID? = null
    open var Name:String? = null
    open var Address1:String? = null
    open var Address2:String? = null
    open var City:String? = null
    open var State:String? = null
    open var Zip:String? = null
    open var Phone:String? = null
    open var Fax:String? = null
    open var TimeZone:String? = null
    open var Active:Boolean? = null
    open var EntDate:Date? = null
    open var ModDate:Date? = null
}

open class LocationsResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Locations:ArrayList<Location> = ArrayList<Location>()
}

Kotlin LocationsRequest 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.

POST /v1/Locations/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
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-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
		}
	},
	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-01,
			ModDate: 0001-01-01
		}
	]
}