Trendsic Platform Service

<back to all web services

NoticeAgreementRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,OPTIONS/v1/noticeAgreement/{AgentId}
PUT,OPTIONS/v1/noticeAgreement/{AgentId}/{Status}
"use strict";
export class NoticeAgreement {
    /** @param {{Id?:number,AgentId?:number,AgentName?:string,Status?:string,SignedDate?:string,FirstViewed?:string,SnoozedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    Status;
    /** @type {string} */
    SignedDate;
    /** @type {string} */
    FirstViewed;
    /** @type {string} */
    SnoozedDate;
}
export class NoticeAgreementResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AgentAgreement?:NoticeAgreement}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {NoticeAgreement} */
    AgentAgreement;
}
export class NoticeAgreementRequest {
    /** @param {{AgentId?:number,Status?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    Status;
}

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

{
	AgentId: 0,
	Status: String
}
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
		}
	},
	AgentAgreement: 
	{
		Id: 0,
		AgentId: 0,
		AgentName: String,
		Status: String,
		SignedDate: 0001-01-01,
		FirstViewed: 0001-01-01,
		SnoozedDate: 0001-01-01
	}
}