Trendsic Platform Service

<back to all web services

AgentAgreementDocRequest

The following routes are available for this service:
GET,DELETE,POST,PUT,OPTIONS/v1/AgentAgreementDoc/{AgentRegistrationTempId}
GET,DELETE,POST,PUT,OPTIONS/v1/AgentAgreementDoc
import Foundation
import ServiceStack

public class AgentAgreementDocRequest : Codable
{
    public var agentRegistrationTempId:Int

    required public init(){}
}

public class AgentAgreementDocResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var agentAgreementDisclosureDocs:[AgentAgreementDoc] = []

    required public init(){}
}

public class AgentAgreementDoc : Codable
{
    public var id:Int
    public var applicationId:String
    public var name:String
    public var version:Int
    public var legalRegion:String
    public var section:String
    public var fileExtension:String
    public var fileName:String
    public var order:Int
    public var active:Bool

    required public init(){}
}


Swift AgentAgreementDocRequest 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/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>