Trendsic Platform Service

<back to all web services

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
Clients Parameters:
NameParameterData TypeRequiredDescription
ApiKeybodyGuidNo
ClientObject Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
SubscriptionIdformGuidNo
ActiveformboolNo
EntDateformDateTimeNo
ModDateformDateTimeNo
ClientsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ClientsformList<ClientObject>No

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/Clients/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: 00000000000000000000000000000000,
	Id: 00000000000000000000000000000000,
	Name: String,
	Address1: String,
	Address2: String,
	City: String,
	State: String,
	Zip: String,
	SubscriptionId: 00000000000000000000000000000000,
	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
		}
	},
	Clients: 
	[
		{
			Id: 00000000000000000000000000000000,
			Name: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			SubscriptionId: 00000000000000000000000000000000,
			Active: False,
			EntDate: 0001-01-01,
			ModDate: 0001-01-01
		}
	]
}