Trendsic Platform Service

MarkupRaiseRequest

The following routes are available for this service:
POST,OPTIONS	/v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise}

"use strict";
export class DocumentMarkupLink {
    /** @param {{DocumentMarkupLinkID?:number,AttachmentId?:string,VersionNo?:number,PageIndex?:number,ShapeId?:string,EntityType?:string,EntityID?:number,EntityNo?:string,CreatedBy?:string,CreatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DocumentMarkupLinkID;
    /** @type {string} */
    AttachmentId;
    /** @type {number} */
    VersionNo;
    /** @type {number} */
    PageIndex;
    /** @type {string} */
    ShapeId;
    /** @type {string} */
    EntityType;
    /** @type {number} */
    EntityID;
    /** @type {string} */
    EntityNo;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
}
export class MarkupRaiseResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Link?:DocumentMarkupLink,Links?:DocumentMarkupLink[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {DocumentMarkupLink} */
    Link;
    /** @type {DocumentMarkupLink[]} */
    Links = [];
}
export class MarkupRaiseRequest {
    /** @param {{AttachmentId?:string,VersionNo?:number,PageIndex?:number,ShapeId?:string,Raise?:string,ProjectID?:number,Title?:string,Description?:string,Area?:string,Trade?:string,AssignedSub?:string,Priority?:string,AskedOf?:string,Discipline?:string,DueDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttachmentId;
    /** @type {number} */
    VersionNo;
    /** @type {number} */
    PageIndex;
    /** @type {string} */
    ShapeId;
    /** @type {string} */
    Raise;
    /** @type {?number} */
    ProjectID;
    /** @type {string} */
    Title;
    /** @type {string} */
    Description;
    /** @type {string} */
    Area;
    /** @type {string} */
    Trade;
    /** @type {string} */
    AssignedSub;
    /** @type {string} */
    Priority;
    /** @type {string} */
    AskedOf;
    /** @type {string} */
    Discipline;
    /** @type {?string} */
    DueDate;
}

JavaScript MarkupRaiseRequest 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 /v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise} 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,
	ShapeId: String,
	Raise: String,
	ProjectID: 0,
	Title: String,
	Description: String,
	Area: String,
	Trade: String,
	AssignedSub: String,
	Priority: String,
	AskedOf: String,
	Discipline: String,
	DueDate: 0001-01-01
}

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
		}
	},
	Link: 
	{
		DocumentMarkupLinkID: 0,
		AttachmentId: 00000000000000000000000000000000,
		VersionNo: 0,
		PageIndex: 0,
		ShapeId: String,
		EntityType: String,
		EntityID: 0,
		EntityNo: String,
		CreatedBy: String,
		CreatedAt: 0001-01-01
	},
	Links: 
	[
		{
			DocumentMarkupLinkID: 0,
			AttachmentId: 00000000000000000000000000000000,
			VersionNo: 0,
			PageIndex: 0,
			ShapeId: String,
			EntityType: String,
			EntityID: 0,
			EntityNo: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01
		}
	]
}