Trendsic Platform Service

<back to all web services

Employees

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/Employees/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/Employees

export class EmployeeObject
{
    public Id: string;
    public Name: string;
    public Active: boolean;

    public constructor(init?: Partial<EmployeeObject>) { (Object as any).assign(this, init); }
}

export class EmployeesResponse
{
    public ResponseStatus: ResponseStatus;
    public Employees: EmployeeObject[] = [];

    public constructor(init?: Partial<EmployeesResponse>) { (Object as any).assign(this, init); }
}

export class Employees extends EmployeeObject
{
    public ApiKey: string;

    public constructor(init?: Partial<Employees>) { super(init); (Object as any).assign(this, init); }
}

TypeScript Employees 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/Employees/{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,
	Active: False
}
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
		}
	},
	Employees: 
	[
		{
			Id: 00000000000000000000000000000000,
			Name: String,
			Active: False
		}
	]
}