Trendsic Platform Service

<back to all web services

AgentAgreementRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,DELETE,POST,PUT,OPTIONS/v1/AgentAgreement/{AgentId}
"use strict";
export class AgentAgreement {
    /** @param {{Id?:number,AgentRegistrationTempId?:number,AgentAgreementDocId?:number,Signed?:boolean,SignedDate?:string,FileName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    AgentRegistrationTempId;
    /** @type {number} */
    AgentAgreementDocId;
    /** @type {boolean} */
    Signed;
    /** @type {string} */
    SignedDate;
    /** @type {string} */
    FileName;
}
export class AgentAgreementResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AgentAgreements?:AgentAgreement[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentAgreement[]} */
    AgentAgreements = [];
}
export class AgentAgreementRequest {
    /** @param {{AgentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
}

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

{
	AgentId: 0
}
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
		}
	},
	AgentAgreements: 
	[
		{
			Id: 0,
			AgentRegistrationTempId: 0,
			AgentAgreementDocId: 0,
			Signed: False,
			SignedDate: 0001-01-01,
			FileName: String
		}
	]
}