Trendsic Platform Service

CRMimageRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS	/v1/CRMimage/{ContactId}

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class Document implements IConvertible
{
    String? DocumentId;
    String? DocType;
    String? DocCategory;
    String? DocSubCategory;
    String? DocTitle;
    String? DocDescription;
    Uint8List? DocData = [];
    DateTime? DocExpiration;
    String? DocMimeType;
    int? DisplayOrder;
    double? FileSizeInKB;
    String? Link;
    DateTime? UploadDate;
    String? DocKey;

    Document({this.DocumentId,this.DocType,this.DocCategory,this.DocSubCategory,this.DocTitle,this.DocDescription,this.DocData,this.DocExpiration,this.DocMimeType,this.DisplayOrder,this.FileSizeInKB,this.Link,this.UploadDate,this.DocKey});
    Document.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DocumentId = json['DocumentId'];
        DocType = json['DocType'];
        DocCategory = json['DocCategory'];
        DocSubCategory = json['DocSubCategory'];
        DocTitle = json['DocTitle'];
        DocDescription = json['DocDescription'];
        DocData = JsonConverters.fromJson(json['DocData'],'Uint8List',context!);
        DocExpiration = JsonConverters.fromJson(json['DocExpiration'],'DateTime',context!);
        DocMimeType = json['DocMimeType'];
        DisplayOrder = json['DisplayOrder'];
        FileSizeInKB = JsonConverters.toDouble(json['FileSizeInKB']);
        Link = json['Link'];
        UploadDate = JsonConverters.fromJson(json['UploadDate'],'DateTime',context!);
        DocKey = json['DocKey'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DocumentId': DocumentId,
        'DocType': DocType,
        'DocCategory': DocCategory,
        'DocSubCategory': DocSubCategory,
        'DocTitle': DocTitle,
        'DocDescription': DocDescription,
        'DocData': JsonConverters.toJson(DocData,'Uint8List',context!),
        'DocExpiration': JsonConverters.toJson(DocExpiration,'DateTime',context!),
        'DocMimeType': DocMimeType,
        'DisplayOrder': DisplayOrder,
        'FileSizeInKB': FileSizeInKB,
        'Link': Link,
        'UploadDate': JsonConverters.toJson(UploadDate,'DateTime',context!),
        'DocKey': DocKey
    };

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

class DocumentResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<Document>? Document = [];

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

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

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

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

class CRMimageRequest implements IConvertible
{
    List<Document>? Document = [];
    int? ContactId;
    Map<String,String?>? Fields = {};

    CRMimageRequest({this.Document,this.ContactId,this.Fields});
    CRMimageRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Document = JsonConverters.fromJson(json['Document'],'List<Document>',context!);
        ContactId = json['ContactId'];
        Fields = JsonConverters.toStringMap(json['Fields']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Document': JsonConverters.toJson(Document,'List<Document>',context!),
        'ContactId': ContactId,
        'Fields': Fields
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'Document': TypeInfo(TypeOf.Class, create:() => Document()),
    'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
    'DocumentResponse': TypeInfo(TypeOf.Class, create:() => DocumentResponse()),
    'List<Document>': TypeInfo(TypeOf.Class, create:() => <Document>[]),
    'CRMimageRequest': TypeInfo(TypeOf.Class, create:() => CRMimageRequest()),
});

Dart CRMimageRequest 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/CRMimage/{ContactId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CRMimageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactId>0</ContactId>
  <Document>
    <Document>
      <DisplayOrder>0</DisplayOrder>
      <DocCategory>String</DocCategory>
      <DocData>AA==</DocData>
      <DocDescription>String</DocDescription>
      <DocExpiration>0001-01-01T00:00:00</DocExpiration>
      <DocKey>String</DocKey>
      <DocMimeType>String</DocMimeType>
      <DocSubCategory>String</DocSubCategory>
      <DocTitle>String</DocTitle>
      <DocType>String</DocType>
      <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
      <FileSizeInKB>0</FileSizeInKB>
      <Link>String</Link>
      <UploadDate>0001-01-01T00:00:00</UploadDate>
    </Document>
  </Document>
  <Fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Fields>
</CRMimageRequest>

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

<DocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Document>
    <Document>
      <DisplayOrder>0</DisplayOrder>
      <DocCategory>String</DocCategory>
      <DocData>AA==</DocData>
      <DocDescription>String</DocDescription>
      <DocExpiration>0001-01-01T00:00:00</DocExpiration>
      <DocKey>String</DocKey>
      <DocMimeType>String</DocMimeType>
      <DocSubCategory>String</DocSubCategory>
      <DocTitle>String</DocTitle>
      <DocType>String</DocType>
      <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
      <FileSizeInKB>0</FileSizeInKB>
      <Link>String</Link>
      <UploadDate>0001-01-01T00:00:00</UploadDate>
    </Document>
  </Document>
  <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>
</DocumentResponse>