Trendsic Platform Service

<back to all web services

ProjectAttachmentRequest

The following routes are available for this service:
POST,OPTIONS/v1/Attachment/ProjectFiles/{TableName}/{FieldName}/{RecordId}
POST,OPTIONS/v1/Attachment/ProjectFiles/{TableName}/{FieldName}/{RecordId}/{NeedsOCR}
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 Attachment() = 
        member val AttachmentId:Guid = new Guid() with get,set
        member val TableName:String = null with get,set
        member val FieldName:String = null with get,set
        member val RecordId:Int32 = new Int32() with get,set
        member val AttachmentName:String = null with get,set
        member val MimeType:String = null with get,set
        member val AttachmentData:Byte[] = [||] with get,set
        member val FileSizeInKB:Double = new Double() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val CreatedBy:String = null with get,set
        member val NeedsOCR:Boolean = new Boolean() with get,set
        member val OCRDate:DateTime = new DateTime() with get,set
        member val IsSecurities:Boolean = new Boolean() with get,set
        member val AWSKey:String = null with get,set
        member val PresignedUrl:String = null with get,set

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

    [<AllowNullLiteral>]
    type ProjectAttachmentRequest() = 
        member val Attachment:ResizeArray<Attachment> = new ResizeArray<Attachment>() with get,set
        member val AttachmentId:Guid = new Guid() with get,set
        member val TableName:String = null with get,set
        member val FieldName:String = null with get,set
        member val RecordId:Int32 = new Int32() with get,set
        member val NeedsOCR:Boolean = new Boolean() with get,set

F# ProjectAttachmentRequest 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/Attachment/ProjectFiles/{TableName}/{FieldName}/{RecordId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Attachment: 
	[
		{
			AttachmentId: 00000000000000000000000000000000,
			TableName: String,
			FieldName: String,
			RecordId: 0,
			AttachmentName: String,
			MimeType: String,
			AttachmentData: AA==,
			FileSizeInKB: 0,
			CreatedDate: 0001-01-01,
			CreatedBy: String,
			NeedsOCR: False,
			OCRDate: 0001-01-01,
			IsSecurities: False,
			AWSKey: String,
			PresignedUrl: String
		}
	],
	AttachmentId: 00000000000000000000000000000000,
	TableName: String,
	FieldName: String,
	RecordId: 0,
	NeedsOCR: False
}
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
		}
	},
	Attachment: 
	[
		{
			AttachmentId: 00000000000000000000000000000000,
			TableName: String,
			FieldName: String,
			RecordId: 0,
			AttachmentName: String,
			MimeType: String,
			AttachmentData: AA==,
			FileSizeInKB: 0,
			CreatedDate: 0001-01-01,
			CreatedBy: String,
			NeedsOCR: False,
			OCRDate: 0001-01-01,
			IsSecurities: False,
			AWSKey: String,
			PresignedUrl: String
		}
	]
}