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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Document() = 
        member val DocumentId:Guid = new Guid() with get,set
        member val DocType:String = null with get,set
        member val DocCategory:String = null with get,set
        member val DocSubCategory:String = null with get,set
        member val DocTitle:String = null with get,set
        member val DocDescription:String = null with get,set
        member val DocData:Byte[] = [||] with get,set
        member val DocExpiration:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DocMimeType:String = null with get,set
        member val DisplayOrder:Int32 = new Int32() with get,set
        member val FileSizeInKB:Double = new Double() with get,set
        member val Link:String = null with get,set
        member val UploadDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DocKey:String = null with get,set

    [<AllowNullLiteral>]
    type DocumentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Document:ResizeArray<Document> = new ResizeArray<Document>() with get,set

    [<AllowNullLiteral>]
    type CRMimageRequest() = 
        member val Document:ResizeArray<Document> = new ResizeArray<Document>() with get,set
        member val ContactId:Int32 = new Int32() with get,set
        member val Fields:Dictionary<String, String> = new Dictionary<String, String>() with get,set

F# 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
		}
	]
}