Trendsic Platform Service

<back to all web services

MarkupPageRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}
MarkupPageRequest Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdpathGuidNo
VersionNopathintNo
PageIndexpathintNo
LayerJsonbodystringNo
MarkupPageResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AttachmentIdformGuidNo
VersionNoformintNo
PageIndexformintNo
LayersformList<DocumentMarkupLayer>No
LinksformList<DocumentMarkupLink>No
MineformDocumentMarkupLayerNo
CanCreatePunchformboolNo
CanCreateRfiformboolNo
ProjectIDformint?No
DocumentMarkupLayer Parameters:
NameParameterData TypeRequiredDescription
DocumentMarkupIDformintNo
AttachmentIdformGuidNo
VersionNoformintNo
PageIndexformintNo
AuthorUserIdformstringNo
AuthorNameformstringNo
LayerJsonformstringNo
ShapeCountformintNo
IsPublishedformboolNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
IsMineformboolNo
DocumentMarkupLink Parameters:
NameParameterData TypeRequiredDescription
DocumentMarkupLinkIDformintNo
AttachmentIdformGuidNo
VersionNoformintNo
PageIndexformintNo
ShapeIdformstringNo
EntityTypeformstringNo
EntityIDformintNo
EntityNoformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"AttachmentId":"00000000000000000000000000000000","VersionNo":0,"PageIndex":0,"LayerJson":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","IsMine":false}],"Links":[{"DocumentMarkupLinkID":0,"AttachmentId":"00000000000000000000000000000000","VersionNo":0,"PageIndex":0,"ShapeId":"String","EntityType":"String","EntityID":0,"EntityNo":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000"}],"Mine":{"DocumentMarkupID":0,"AttachmentId":"00000000000000000000000000000000","VersionNo":0,"PageIndex":0,"AuthorUserId":"String","AuthorName":"String","LayerJson":"String","ShapeCount":0,"IsPublished":false,"CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","IsMine":false},"CanCreatePunch":false,"CanCreateRfi":false,"ProjectID":0}