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}

export class Document
{
    public DocumentId: string;
    public DocType: string;
    public DocCategory: string;
    public DocSubCategory: string;
    public DocTitle: string;
    public DocDescription: string;
    public DocData: string = [];
    public DocExpiration?: string;
    public DocMimeType: string;
    public DisplayOrder: number;
    public FileSizeInKB: number;
    public Link: string;
    public UploadDate?: string;
    public DocKey: string;

    public constructor(init?: Partial<Document>) { (Object as any).assign(this, init); }
}

export class DocumentResponse
{
    public ResponseStatus: ResponseStatus;
    public Document: Document[] = [];

    public constructor(init?: Partial<DocumentResponse>) { (Object as any).assign(this, init); }
}

export class CRMimageRequest
{
    public Document: Document[] = [];
    public ContactId: number;
    public Fields: { [index:string]: string; } = {};

    public constructor(init?: Partial<CRMimageRequest>) { (Object as any).assign(this, init); }
}

TypeScript CRMimageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Document: 
	[
		{
			DocumentId: 00000000000000000000000000000000,
			DocType: String,
			DocCategory: String,
			DocSubCategory: String,
			DocTitle: String,
			DocDescription: String,
			DocData: AA==,
			DocExpiration: 0001-01-01,
			DocMimeType: String,
			DisplayOrder: 0,
			FileSizeInKB: 0,
			Link: String,
			UploadDate: 0001-01-01,
			DocKey: String
		}
	],
	ContactId: 0,
	Fields: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			DocMimeType: String,
			DisplayOrder: 0,
			FileSizeInKB: 0,
			Link: String,
			UploadDate: 0001-01-01,
			DocKey: String
		}
	]
}