| GET,DELETE,POST,PUT,OPTIONS | /v1/AgentAgreementDoc/{AgentRegistrationTempId} | ||
|---|---|---|---|
| GET,DELETE,POST,PUT,OPTIONS | /v1/AgentAgreementDoc |
"use strict";
export class AgentAgreementDoc {
/** @param {{Id?:number,ApplicationId?:string,Name?:string,Version?:number,LegalRegion?:string,Section?:string,FileExtension?:string,FileName?:string,Order?:number,Active?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
ApplicationId;
/** @type {string} */
Name;
/** @type {number} */
Version;
/** @type {string} */
LegalRegion;
/** @type {string} */
Section;
/** @type {string} */
FileExtension;
/** @type {string} */
FileName;
/** @type {number} */
Order;
/** @type {boolean} */
Active;
}
export class AgentAgreementDocResponse {
/** @param {{ResponseStatus?:ResponseStatus,AgentAgreementDisclosureDocs?:AgentAgreementDoc[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {AgentAgreementDoc[]} */
AgentAgreementDisclosureDocs = [];
}
export class AgentAgreementDocRequest {
/** @param {{AgentRegistrationTempId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AgentRegistrationTempId;
}
JavaScript AgentAgreementDocRequest 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/AgentAgreementDoc/{AgentRegistrationTempId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AgentAgreementDocRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentRegistrationTempId>0</AgentRegistrationTempId>
</AgentAgreementDocRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentAgreementDocResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentAgreementDisclosureDocs>
<AgentAgreementDoc>
<Active>false</Active>
<ApplicationId>String</ApplicationId>
<FileExtension>String</FileExtension>
<FileName>String</FileName>
<Id>0</Id>
<LegalRegion>String</LegalRegion>
<Name>String</Name>
<Order>0</Order>
<Section>String</Section>
<Version>0</Version>
</AgentAgreementDoc>
</AgentAgreementDisclosureDocs>
<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>
</AgentAgreementDocResponse>