| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<NoticeAgreementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentId>0</AgentId>
<Status>String</Status>
</NoticeAgreementRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NoticeAgreementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentAgreement>
<AgentId>0</AgentId>
<AgentName>String</AgentName>
<FirstViewed>0001-01-01T00:00:00</FirstViewed>
<Id>0</Id>
<SignedDate>0001-01-01T00:00:00</SignedDate>
<SnoozedDate>0001-01-01T00:00:00</SnoozedDate>
<Status>String</Status>
</AgentAgreement>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</NoticeAgreementResponse>