Trendsic Platform Service

MarkupPageRequest

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


export class DocumentMarkupLayer
{
    public DocumentMarkupID: number;
    public AttachmentId: string;
    public VersionNo: number;
    public PageIndex: number;
    public AuthorUserId: string;
    public AuthorName: string;
    public LayerJson: string;
    public ShapeCount: number;
    public IsPublished: boolean;
    public CreatedAt?: string;
    public UpdatedAt?: string;
    public IsMine: boolean;

    public constructor(init?: Partial<DocumentMarkupLayer>) { (Object as any).assign(this, init); }
}

export class DocumentMarkupLink
{
    public DocumentMarkupLinkID: number;
    public AttachmentId: string;
    public VersionNo: number;
    public PageIndex: number;
    public ShapeId: string;
    public EntityType: string;
    public EntityID: number;
    public EntityNo: string;
    public CreatedBy: string;
    public CreatedAt?: string;

    public constructor(init?: Partial<DocumentMarkupLink>) { (Object as any).assign(this, init); }
}

export class MarkupPageResponse
{
    public ResponseStatus: ResponseStatus;
    public AttachmentId: string;
    public VersionNo: number;
    public PageIndex: number;
    public Layers: DocumentMarkupLayer[] = [];
    public Links: DocumentMarkupLink[] = [];
    public Mine: DocumentMarkupLayer;
    public CanCreatePunch: boolean;
    public CanCreateRfi: boolean;
    public ProjectID?: number;

    public constructor(init?: Partial<MarkupPageResponse>) { (Object as any).assign(this, init); }
}

export class MarkupPageRequest
{
    public AttachmentId: string;
    public VersionNo: number;
    public PageIndex: number;
    public LayerJson: string;

    public constructor(init?: Partial<MarkupPageRequest>) { (Object as any).assign(this, init); }
}

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