Trendsic Platform Service

MarkupPageRequest

The following routes are available for this service:
GET,PUT,OPTIONS	/v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}

import Foundation
import ServiceStack

public class MarkupPageRequest : Codable
{
    public var attachmentId:String
    public var versionNo:Int
    public var pageIndex:Int
    public var layerJson:String

    required public init(){}
}

public class MarkupPageResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var attachmentId:String
    public var versionNo:Int
    public var pageIndex:Int
    public var layers:[DocumentMarkupLayer] = []
    public var links:[DocumentMarkupLink] = []
    public var mine:DocumentMarkupLayer
    public var canCreatePunch:Bool
    public var canCreateRfi:Bool
    public var projectID:Int?

    required public init(){}
}

public class DocumentMarkupLayer : Codable
{
    public var documentMarkupID:Int
    public var attachmentId:String
    public var versionNo:Int
    public var pageIndex:Int
    public var authorUserId:String
    public var authorName:String
    public var layerJson:String
    public var shapeCount:Int
    public var isPublished:Bool
    public var createdAt:Date?
    public var updatedAt:Date?
    public var isMine:Bool

    required public init(){}
}

public class DocumentMarkupLink : Codable
{
    public var documentMarkupLinkID:Int
    public var attachmentId:String
    public var versionNo:Int
    public var pageIndex:Int
    public var shapeId:String
    public var entityType:String
    public var entityID:Int
    public var entityNo:String
    public var createdBy:String
    public var createdAt:Date?

    required public init(){}
}

Swift MarkupPageRequest 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/markup/{AttachmentId}/{VersionNo}/{PageIndex} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AttachmentId: 00000000000000000000000000000000,
	VersionNo: 0,
	PageIndex: 0,
	LayerJson: 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
		}
	},
	AttachmentId: 00000000000000000000000000000000,
	VersionNo: 0,
	PageIndex: 0,
	Layers: 
	[
		{
			DocumentMarkupID: 0,
			AttachmentId: 00000000000000000000000000000000,
			VersionNo: 0,
			PageIndex: 0,
			AuthorUserId: String,
			AuthorName: String,
			LayerJson: String,
			ShapeCount: 0,
			IsPublished: False,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			IsMine: False
		}
	],
	Links: 
	[
		{
			DocumentMarkupLinkID: 0,
			AttachmentId: 00000000000000000000000000000000,
			VersionNo: 0,
			PageIndex: 0,
			ShapeId: String,
			EntityType: String,
			EntityID: 0,
			EntityNo: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01
		}
	],
	Mine: 
	{
		DocumentMarkupID: 0,
		AttachmentId: 00000000000000000000000000000000,
		VersionNo: 0,
		PageIndex: 0,
		AuthorUserId: String,
		AuthorName: String,
		LayerJson: String,
		ShapeCount: 0,
		IsPublished: False,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01,
		IsMine: False
	},
	CanCreatePunch: False,
	CanCreateRfi: False,
	ProjectID: 0
}