Trendsic Platform Service

MarkupPageRequest

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

**MarkupPageRequest** Parameters:
Name	Parameter	Data Type	Required
AttachmentId	path	Guid	No
VersionNo	path	int	No
PageIndex	path	int	No
LayerJson	body	string	No

**MarkupPageResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
AttachmentId	form	Guid	No
VersionNo	form	int	No
PageIndex	form	int	No
Layers	form	List<DocumentMarkupLayer>	No
Links	form	List<DocumentMarkupLink>	No
Mine	form	DocumentMarkupLayer	No
CanCreatePunch	form	bool	No
CanCreateRfi	form	bool	No
ProjectID	form	int?	No

**DocumentMarkupLayer** Parameters:
Name	Parameter	Data Type	Required
DocumentMarkupID	form	int	No
AttachmentId	form	Guid	No
VersionNo	form	int	No
PageIndex	form	int	No
AuthorUserId	form	string	No
AuthorName	form	string	No
LayerJson	form	string	No
ShapeCount	form	int	No
IsPublished	form	bool	No
CreatedAt	form	DateTime?	No
UpdatedAt	form	DateTime?	No
IsMine	form	bool	No

**DocumentMarkupLink** Parameters:
Name	Parameter	Data Type	Required
DocumentMarkupLinkID	form	int	No
AttachmentId	form	Guid	No
VersionNo	form	int	No
PageIndex	form	int	No
ShapeId	form	string	No
EntityType	form	string	No
EntityID	form	int	No
EntityNo	form	string	No
CreatedBy	form	string	No
CreatedAt	form	DateTime?	No

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
}