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
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class PhotoAnnotation implements IConvertible
{
    int? PhotoAnnotationID;
    String? AttachmentId;
    String? AnnotationJson;
    String? FlattenedAttachmentId;
    String? FlattenedUrl;
    String? CreatedBy;
    DateTime? CreatedAt;
    DateTime? UpdatedAt;

    PhotoAnnotation({this.PhotoAnnotationID,this.AttachmentId,this.AnnotationJson,this.FlattenedAttachmentId,this.FlattenedUrl,this.CreatedBy,this.CreatedAt,this.UpdatedAt});
    PhotoAnnotation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PhotoAnnotationID = json['PhotoAnnotationID'];
        AttachmentId = json['AttachmentId'];
        AnnotationJson = json['AnnotationJson'];
        FlattenedAttachmentId = json['FlattenedAttachmentId'];
        FlattenedUrl = json['FlattenedUrl'];
        CreatedBy = json['CreatedBy'];
        CreatedAt = JsonConverters.fromJson(json['CreatedAt'],'DateTime',context!);
        UpdatedAt = JsonConverters.fromJson(json['UpdatedAt'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PhotoAnnotationID': PhotoAnnotationID,
        'AttachmentId': AttachmentId,
        'AnnotationJson': AnnotationJson,
        'FlattenedAttachmentId': FlattenedAttachmentId,
        'FlattenedUrl': FlattenedUrl,
        'CreatedBy': CreatedBy,
        'CreatedAt': JsonConverters.toJson(CreatedAt,'DateTime',context!),
        'UpdatedAt': JsonConverters.toJson(UpdatedAt,'DateTime',context!)
    };

    getTypeName() => "PhotoAnnotation";
    TypeContext? context = _ctx;
}

class PhotoAnnotationResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    PhotoAnnotation? Annotation;
    String? OriginalUrl;

    PhotoAnnotationResponse({this.ResponseStatus,this.Annotation,this.OriginalUrl});
    PhotoAnnotationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Annotation = JsonConverters.fromJson(json['Annotation'],'PhotoAnnotation',context!);
        OriginalUrl = json['OriginalUrl'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Annotation': JsonConverters.toJson(Annotation,'PhotoAnnotation',context!),
        'OriginalUrl': OriginalUrl
    };

    getTypeName() => "PhotoAnnotationResponse";
    TypeContext? context = _ctx;
}

class PhotoAnnotationRequest implements IConvertible
{
    String? AttachmentId;
    String? AnnotationJson;
    String? FlattenedDataUrl;

    PhotoAnnotationRequest({this.AttachmentId,this.AnnotationJson,this.FlattenedDataUrl});
    PhotoAnnotationRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AttachmentId = json['AttachmentId'];
        AnnotationJson = json['AnnotationJson'];
        FlattenedDataUrl = json['FlattenedDataUrl'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AttachmentId': AttachmentId,
        'AnnotationJson': AnnotationJson,
        'FlattenedDataUrl': FlattenedDataUrl
    };

    getTypeName() => "PhotoAnnotationRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'PhotoAnnotation': TypeInfo(TypeOf.Class, create:() => PhotoAnnotation()),
    'PhotoAnnotationResponse': TypeInfo(TypeOf.Class, create:() => PhotoAnnotationResponse()),
    'PhotoAnnotationRequest': TypeInfo(TypeOf.Class, create:() => PhotoAnnotationRequest()),
});

Dart 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
}