Trendsic Platform Service

<back to all web services

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"Document":[{"DocumentId":"00000000000000000000000000000000","DocType":"String","DocCategory":"String","DocSubCategory":"String","DocTitle":"String","DocDescription":"String","DocData":"AA==","DocExpiration":"0001-01-01T00:00:00.0000000","DocMimeType":"String","DisplayOrder":0,"FileSizeInKB":0,"Link":"String","UploadDate":"0001-01-01T00:00:00.0000000","DocKey":"String"}],"ContactId":0,"Fields":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Document":[{"DocumentId":"00000000000000000000000000000000","DocType":"String","DocCategory":"String","DocSubCategory":"String","DocTitle":"String","DocDescription":"String","DocData":"AA==","DocExpiration":"0001-01-01T00:00:00.0000000","DocMimeType":"String","DisplayOrder":0,"FileSizeInKB":0,"Link":"String","UploadDate":"0001-01-01T00:00:00.0000000","DocKey":"String"}]}