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}

"use strict";
export class Document {
    /** @param {{DocumentId?:string,DocType?:string,DocCategory?:string,DocSubCategory?:string,DocTitle?:string,DocDescription?:string,DocData?:string,DocExpiration?:string,DocMimeType?:string,DisplayOrder?:number,FileSizeInKB?:number,Link?:string,UploadDate?:string,DocKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentId;
    /** @type {string} */
    DocType;
    /** @type {string} */
    DocCategory;
    /** @type {string} */
    DocSubCategory;
    /** @type {string} */
    DocTitle;
    /** @type {string} */
    DocDescription;
    /** @type {string} */
    DocData = [];
    /** @type {?string} */
    DocExpiration;
    /** @type {string} */
    DocMimeType;
    /** @type {number} */
    DisplayOrder;
    /** @type {number} */
    FileSizeInKB;
    /** @type {string} */
    Link;
    /** @type {?string} */
    UploadDate;
    /** @type {string} */
    DocKey;
}
export class DocumentResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Document?:Document[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Document[]} */
    Document = [];
}
export class CRMimageRequest {
    /** @param {{Document?:Document[],ContactId?:number,Fields?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Document[]} */
    Document = [];
    /** @type {number} */
    ContactId;
    /** @type {{ [index:string]: string; }} */
    Fields = {};
}

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