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

public class dtos
{

    public static class Clients extends ClientObject
    {
        public UUID ApiKey = null;
        
        public UUID getApiKey() { return ApiKey; }
        public Clients setApiKey(UUID value) { this.ApiKey = value; return this; }
    }

    public static class ClientObject
    {
        public UUID Id = null;
        public String Name = null;
        public String Address1 = null;
        public String Address2 = null;
        public String City = null;
        public String State = null;
        public String Zip = null;
        public UUID SubscriptionId = null;
        public Boolean Active = null;
        public Date EntDate = null;
        public Date ModDate = null;
        
        public UUID getId() { return Id; }
        public ClientObject setId(UUID value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public ClientObject setName(String value) { this.Name = value; return this; }
        public String getAddress1() { return Address1; }
        public ClientObject setAddress1(String value) { this.Address1 = value; return this; }
        public String getAddress2() { return Address2; }
        public ClientObject setAddress2(String value) { this.Address2 = value; return this; }
        public String getCity() { return City; }
        public ClientObject setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public ClientObject setState(String value) { this.State = value; return this; }
        public String getZip() { return Zip; }
        public ClientObject setZip(String value) { this.Zip = value; return this; }
        public UUID getSubscriptionId() { return SubscriptionId; }
        public ClientObject setSubscriptionId(UUID value) { this.SubscriptionId = value; return this; }
        public Boolean isActive() { return Active; }
        public ClientObject setActive(Boolean value) { this.Active = value; return this; }
        public Date getEntDate() { return EntDate; }
        public ClientObject setEntDate(Date value) { this.EntDate = value; return this; }
        public Date getModDate() { return ModDate; }
        public ClientObject setModDate(Date value) { this.ModDate = value; return this; }
    }

    public static class ClientsResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<ClientObject> Clients = new ArrayList<ClientObject>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ClientsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<ClientObject> getClients() { return Clients; }
        public ClientsResponse setClients(ArrayList<ClientObject> value) { this.Clients = value; return this; }
    }

}

Java Clients 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/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
		}
	]
}