Platform API

GetAttachments

The following routes are available for this service:
All Verbs	/api/attachments/{ConnectedObjectId}

namespace Eros.Saguna.Common.WebAPIModel.Models

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

    [<AllowNullLiteral>]
    type MediaModel() = 
        member val MediaFileId:Guid = new Guid() with get,set
        member val MediaName:String = null with get,set
        member val FileContent:String = null with get,set
        member val FileContentType:String = null with get,set
        member val FilePath:String = null with get,set
        member val OriginalFileName:String = null with get,set
        member val ImageWidth:Int32 = new Int32() with get,set
        member val ImageHeight:Int32 = new Int32() with get,set
        member val FileSizeKB:Int32 = new Int32() with get,set
        member val BlobUriRaw:String = null with get,set
        member val BlobUriFull:String = null with get,set
        member val BlobUriThumbnail:String = null with get,set
        member val WatermarkUri:String = null with get,set
        member val CapturedDate:DateTime = new DateTime() with get,set
        member val CapturedByContactId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val CapturedByContactName:String = null with get,set
        member val CapturedByContactThumbnailUrl:String = null with get,set
        member val Notes:String = null with get,set
        member val ResourceActionName:String = null with get,set
        member val LocationVerified:String = null with get,set
        member val TrafficLightLocationVerified:Guid = new Guid() with get,set
        member val AudienceLevel:String = null with get,set
        member val WorksFor:String = null with get,set

    [<ApiResponse(Description="Returns list of attachments linked to an object.")>]
    [<AllowNullLiteral>]
    type GetAttachmentsResponse() = 
        member val Attachments:ResizeArray<MediaModel> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GetAttachments() = 
        ///<summary>
        ///Object for which primary image is to be uploaded.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Object for which primary image is to be uploaded.", IsRequired=true, Name="ConnectedObjectId")>]
        member val ConnectedObjectId:Guid = new Guid() with get,set

F# GetAttachments 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 /api/attachments/{ConnectedObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Attachments: 
	[
		{
			MediaName: String,
			FileContent: String,
			FileContentType: String,
			FilePath: String,
			OriginalFileName: String,
			ImageWidth: 0,
			ImageHeight: 0,
			FileSizeKB: 0,
			BlobUriRaw: String,
			BlobUriFull: String,
			BlobUriThumbnail: String,
			WatermarkUri: String,
			CapturedDate: 0001-01-01,
			CapturedByContactId: 00000000000000000000000000000000,
			CapturedByContactName: String,
			CapturedByContactThumbnailUrl: String,
			Notes: String,
			ResourceActionName: String,
			LocationVerified: String,
			AudienceLevel: String,
			WorksFor: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}