Trendsic Platform Service

<back to all web services

PhotoAnnotationRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/photos/{AttachmentId}/annotation
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 PhotoAnnotation() = 
        member val PhotoAnnotationID:Int32 = new Int32() with get,set
        member val AttachmentId:Guid = new Guid() with get,set
        member val AnnotationJson:String = null with get,set
        member val FlattenedAttachmentId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val FlattenedUrl:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type PhotoAnnotationResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Annotation:PhotoAnnotation = null with get,set
        member val OriginalUrl:String = null with get,set

    [<AllowNullLiteral>]
    type PhotoAnnotationRequest() = 
        member val AttachmentId:Guid = new Guid() with get,set
        member val AnnotationJson:String = null with get,set
        member val FlattenedDataUrl:String = null with get,set

F# PhotoAnnotationRequest 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.

PUT /v1/photos/{AttachmentId}/annotation HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AttachmentId: 00000000000000000000000000000000,
	AnnotationJson: String,
	FlattenedDataUrl: 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
		}
	},
	Annotation: 
	{
		PhotoAnnotationID: 0,
		AttachmentId: 00000000000000000000000000000000,
		AnnotationJson: String,
		FlattenedAttachmentId: 00000000000000000000000000000000,
		FlattenedUrl: String,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01
	},
	OriginalUrl: String
}