Trendsic Platform Service

<back to all web services

NewAgentRequest

Requires Authentication
Required roles:Administrator, Administrator, Administrator
The following routes are available for this service:
GET,PUT,OPTIONS/v1/NewAgent/{AgentId}
GET,POST,OPTIONS/v1/NewAgent
"use strict";
export class NewAgent {
    /** @param {{AgentId?:number,FirstName?:string,LastName?:string,UserName?:string,Email?:string,IsAdmin?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    UserName;
    /** @type {string} */
    Email;
    /** @type {boolean} */
    IsAdmin;
}
export class NewAgentResponse {
    /** @param {{ResponseStatus?:ResponseStatus,NewAgent?:NewAgent[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {NewAgent[]} */
    NewAgent = [];
}
export class NewAgentRequest {
    /** @param {{AgentId?:number,NewAgent?:NewAgent[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {NewAgent[]} */
    NewAgent = [];
}

JavaScript NewAgentRequest 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/NewAgent HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AgentId: 0,
	NewAgent: 
	[
		{
			AgentId: 0,
			FirstName: String,
			LastName: String,
			UserName: String,
			Email: String,
			IsAdmin: 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
		}
	},
	NewAgent: 
	[
		{
			AgentId: 0,
			FirstName: String,
			LastName: String,
			UserName: String,
			Email: String,
			IsAdmin: False
		}
	]
}