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 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class AgentAgreementDoc implements IConvertible
{
    int? Id;
    String? ApplicationId;
    String? Name;
    int? Version;
    String? LegalRegion;
    String? Section;
    String? FileExtension;
    String? FileName;
    int? Order;
    bool? Active;

    AgentAgreementDoc({this.Id,this.ApplicationId,this.Name,this.Version,this.LegalRegion,this.Section,this.FileExtension,this.FileName,this.Order,this.Active});
    AgentAgreementDoc.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        ApplicationId = json['ApplicationId'];
        Name = json['Name'];
        Version = json['Version'];
        LegalRegion = json['LegalRegion'];
        Section = json['Section'];
        FileExtension = json['FileExtension'];
        FileName = json['FileName'];
        Order = json['Order'];
        Active = json['Active'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'ApplicationId': ApplicationId,
        'Name': Name,
        'Version': Version,
        'LegalRegion': LegalRegion,
        'Section': Section,
        'FileExtension': FileExtension,
        'FileName': FileName,
        'Order': Order,
        'Active': Active
    };

    getTypeName() => "AgentAgreementDoc";
    TypeContext? context = _ctx;
}

class AgentAgreementDocResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<AgentAgreementDoc>? AgentAgreementDisclosureDocs = [];

    AgentAgreementDocResponse({this.ResponseStatus,this.AgentAgreementDisclosureDocs});
    AgentAgreementDocResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        AgentAgreementDisclosureDocs = JsonConverters.fromJson(json['AgentAgreementDisclosureDocs'],'List<AgentAgreementDoc>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'AgentAgreementDisclosureDocs': JsonConverters.toJson(AgentAgreementDisclosureDocs,'List<AgentAgreementDoc>',context!)
    };

    getTypeName() => "AgentAgreementDocResponse";
    TypeContext? context = _ctx;
}

class AgentAgreementDocRequest implements IConvertible
{
    int? AgentRegistrationTempId;

    AgentAgreementDocRequest({this.AgentRegistrationTempId});
    AgentAgreementDocRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgentRegistrationTempId = json['AgentRegistrationTempId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgentRegistrationTempId': AgentRegistrationTempId
    };

    getTypeName() => "AgentAgreementDocRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'AgentAgreementDoc': TypeInfo(TypeOf.Class, create:() => AgentAgreementDoc()),
    'AgentAgreementDocResponse': TypeInfo(TypeOf.Class, create:() => AgentAgreementDocResponse()),
    'List<AgentAgreementDoc>': TypeInfo(TypeOf.Class, create:() => <AgentAgreementDoc>[]),
    'AgentAgreementDocRequest': TypeInfo(TypeOf.Class, create:() => AgentAgreementDocRequest()),
});

Dart 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>