| GET,PUT,OPTIONS | /v1/markup/{AttachmentId}/{VersionNo}/{PageIndex} |
|---|
"use strict";
export class DocumentMarkupLayer {
/** @param {{DocumentMarkupID?:number,AttachmentId?:string,VersionNo?:number,PageIndex?:number,AuthorUserId?:string,AuthorName?:string,LayerJson?:string,ShapeCount?:number,IsPublished?:boolean,CreatedAt?:string,UpdatedAt?:string,IsMine?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DocumentMarkupID;
/** @type {string} */
AttachmentId;
/** @type {number} */
VersionNo;
/** @type {number} */
PageIndex;
/** @type {string} */
AuthorUserId;
/** @type {string} */
AuthorName;
/** @type {string} */
LayerJson;
/** @type {number} */
ShapeCount;
/** @type {boolean} */
IsPublished;
/** @type {?string} */
CreatedAt;
/** @type {?string} */
UpdatedAt;
/** @type {boolean} */
IsMine;
}
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 MarkupPageResponse {
/** @param {{ResponseStatus?:ResponseStatus,AttachmentId?:string,VersionNo?:number,PageIndex?:number,Layers?:DocumentMarkupLayer[],Links?:DocumentMarkupLink[],Mine?:DocumentMarkupLayer,CanCreatePunch?:boolean,CanCreateRfi?:boolean,ProjectID?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {string} */
AttachmentId;
/** @type {number} */
VersionNo;
/** @type {number} */
PageIndex;
/** @type {DocumentMarkupLayer[]} */
Layers = [];
/** @type {DocumentMarkupLink[]} */
Links = [];
/** @type {DocumentMarkupLayer} */
Mine;
/** @type {boolean} */
CanCreatePunch;
/** @type {boolean} */
CanCreateRfi;
/** @type {?number} */
ProjectID;
}
export class MarkupPageRequest {
/** @param {{AttachmentId?:string,VersionNo?:number,PageIndex?:number,LayerJson?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
AttachmentId;
/** @type {number} */
VersionNo;
/** @type {number} */
PageIndex;
/** @type {string} */
LayerJson;
}
JavaScript MarkupPageRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<MarkupPageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<LayerJson>String</LayerJson>
<PageIndex>0</PageIndex>
<VersionNo>0</VersionNo>
</MarkupPageRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<MarkupPageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<CanCreatePunch>false</CanCreatePunch>
<CanCreateRfi>false</CanCreateRfi>
<Layers>
<DocumentMarkupLayer>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<AuthorName>String</AuthorName>
<AuthorUserId>String</AuthorUserId>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<DocumentMarkupID>0</DocumentMarkupID>
<IsMine>false</IsMine>
<IsPublished>false</IsPublished>
<LayerJson>String</LayerJson>
<PageIndex>0</PageIndex>
<ShapeCount>0</ShapeCount>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<VersionNo>0</VersionNo>
</DocumentMarkupLayer>
</Layers>
<Links>
<DocumentMarkupLink>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<DocumentMarkupLinkID>0</DocumentMarkupLinkID>
<EntityID>0</EntityID>
<EntityNo>String</EntityNo>
<EntityType>String</EntityType>
<PageIndex>0</PageIndex>
<ShapeId>String</ShapeId>
<VersionNo>0</VersionNo>
</DocumentMarkupLink>
</Links>
<Mine>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<AuthorName>String</AuthorName>
<AuthorUserId>String</AuthorUserId>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<DocumentMarkupID>0</DocumentMarkupID>
<IsMine>false</IsMine>
<IsPublished>false</IsPublished>
<LayerJson>String</LayerJson>
<PageIndex>0</PageIndex>
<ShapeCount>0</ShapeCount>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<VersionNo>0</VersionNo>
</Mine>
<PageIndex>0</PageIndex>
<ProjectID>0</ProjectID>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<VersionNo>0</VersionNo>
</MarkupPageResponse>