Trendsic Platform Service

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AgentAgreementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentId>0</AgentId>
</AgentAgreementRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentAgreementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentAgreements>
    <AgentAgreement>
      <AgentAgreementDocId>0</AgentAgreementDocId>
      <AgentRegistrationTempId>0</AgentRegistrationTempId>
      <FileName>String</FileName>
      <Id>0</Id>
      <Signed>false</Signed>
      <SignedDate>0001-01-01T00:00:00</SignedDate>
    </AgentAgreement>
  </AgentAgreements>
  <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>
</AgentAgreementResponse>