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}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class MarkupPageRequest
    {
        public UUID AttachmentId = null;
        public Integer VersionNo = null;
        public Integer PageIndex = null;
        public String LayerJson = null;
        
        public UUID getAttachmentId() { return AttachmentId; }
        public MarkupPageRequest setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public Integer getVersionNo() { return VersionNo; }
        public MarkupPageRequest setVersionNo(Integer value) { this.VersionNo = value; return this; }
        public Integer getPageIndex() { return PageIndex; }
        public MarkupPageRequest setPageIndex(Integer value) { this.PageIndex = value; return this; }
        public String getLayerJson() { return LayerJson; }
        public MarkupPageRequest setLayerJson(String value) { this.LayerJson = value; return this; }
    }

    public static class MarkupPageResponse
    {
        public ResponseStatus ResponseStatus = null;
        public UUID AttachmentId = null;
        public Integer VersionNo = null;
        public Integer PageIndex = null;
        public ArrayList<DocumentMarkupLayer> Layers = new ArrayList<DocumentMarkupLayer>();
        public ArrayList<DocumentMarkupLink> Links = new ArrayList<DocumentMarkupLink>();
        public DocumentMarkupLayer Mine = null;
        public Boolean CanCreatePunch = null;
        public Boolean CanCreateRfi = null;
        public Integer ProjectID = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public MarkupPageResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public MarkupPageResponse setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public Integer getVersionNo() { return VersionNo; }
        public MarkupPageResponse setVersionNo(Integer value) { this.VersionNo = value; return this; }
        public Integer getPageIndex() { return PageIndex; }
        public MarkupPageResponse setPageIndex(Integer value) { this.PageIndex = value; return this; }
        public ArrayList<DocumentMarkupLayer> getLayers() { return Layers; }
        public MarkupPageResponse setLayers(ArrayList<DocumentMarkupLayer> value) { this.Layers = value; return this; }
        public ArrayList<DocumentMarkupLink> getLinks() { return Links; }
        public MarkupPageResponse setLinks(ArrayList<DocumentMarkupLink> value) { this.Links = value; return this; }
        public DocumentMarkupLayer getMine() { return Mine; }
        public MarkupPageResponse setMine(DocumentMarkupLayer value) { this.Mine = value; return this; }
        public Boolean isCanCreatePunch() { return CanCreatePunch; }
        public MarkupPageResponse setCanCreatePunch(Boolean value) { this.CanCreatePunch = value; return this; }
        public Boolean isCanCreateRfi() { return CanCreateRfi; }
        public MarkupPageResponse setCanCreateRfi(Boolean value) { this.CanCreateRfi = value; return this; }
        public Integer getProjectID() { return ProjectID; }
        public MarkupPageResponse setProjectID(Integer value) { this.ProjectID = value; return this; }
    }

    public static class DocumentMarkupLayer
    {
        public Integer DocumentMarkupID = null;
        public UUID AttachmentId = null;
        public Integer VersionNo = null;
        public Integer PageIndex = null;
        public String AuthorUserId = null;
        public String AuthorName = null;
        public String LayerJson = null;
        public Integer ShapeCount = null;
        public Boolean IsPublished = null;
        public Date CreatedAt = null;
        public Date UpdatedAt = null;
        public Boolean IsMine = null;
        
        public Integer getDocumentMarkupID() { return DocumentMarkupID; }
        public DocumentMarkupLayer setDocumentMarkupID(Integer value) { this.DocumentMarkupID = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public DocumentMarkupLayer setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public Integer getVersionNo() { return VersionNo; }
        public DocumentMarkupLayer setVersionNo(Integer value) { this.VersionNo = value; return this; }
        public Integer getPageIndex() { return PageIndex; }
        public DocumentMarkupLayer setPageIndex(Integer value) { this.PageIndex = value; return this; }
        public String getAuthorUserId() { return AuthorUserId; }
        public DocumentMarkupLayer setAuthorUserId(String value) { this.AuthorUserId = value; return this; }
        public String getAuthorName() { return AuthorName; }
        public DocumentMarkupLayer setAuthorName(String value) { this.AuthorName = value; return this; }
        public String getLayerJson() { return LayerJson; }
        public DocumentMarkupLayer setLayerJson(String value) { this.LayerJson = value; return this; }
        public Integer getShapeCount() { return ShapeCount; }
        public DocumentMarkupLayer setShapeCount(Integer value) { this.ShapeCount = value; return this; }
        public Boolean getIsPublished() { return IsPublished; }
        public DocumentMarkupLayer setIsPublished(Boolean value) { this.IsPublished = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public DocumentMarkupLayer setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public Date getUpdatedAt() { return UpdatedAt; }
        public DocumentMarkupLayer setUpdatedAt(Date value) { this.UpdatedAt = value; return this; }
        public Boolean getIsMine() { return IsMine; }
        public DocumentMarkupLayer setIsMine(Boolean value) { this.IsMine = value; return this; }
    }

    public static class DocumentMarkupLink
    {
        public Integer DocumentMarkupLinkID = null;
        public UUID AttachmentId = null;
        public Integer VersionNo = null;
        public Integer PageIndex = null;
        public String ShapeId = null;
        public String EntityType = null;
        public Integer EntityID = null;
        public String EntityNo = null;
        public String CreatedBy = null;
        public Date CreatedAt = null;
        
        public Integer getDocumentMarkupLinkID() { return DocumentMarkupLinkID; }
        public DocumentMarkupLink setDocumentMarkupLinkID(Integer value) { this.DocumentMarkupLinkID = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public DocumentMarkupLink setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public Integer getVersionNo() { return VersionNo; }
        public DocumentMarkupLink setVersionNo(Integer value) { this.VersionNo = value; return this; }
        public Integer getPageIndex() { return PageIndex; }
        public DocumentMarkupLink setPageIndex(Integer value) { this.PageIndex = value; return this; }
        public String getShapeId() { return ShapeId; }
        public DocumentMarkupLink setShapeId(String value) { this.ShapeId = value; return this; }
        public String getEntityType() { return EntityType; }
        public DocumentMarkupLink setEntityType(String value) { this.EntityType = value; return this; }
        public Integer getEntityID() { return EntityID; }
        public DocumentMarkupLink setEntityID(Integer value) { this.EntityID = value; return this; }
        public String getEntityNo() { return EntityNo; }
        public DocumentMarkupLink setEntityNo(String value) { this.EntityNo = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public DocumentMarkupLink setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public DocumentMarkupLink setCreatedAt(Date value) { this.CreatedAt = value; return this; }
    }

}

Java MarkupPageRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"AttachmentId":"00000000000000000000000000000000","VersionNo":0,"PageIndex":0,"LayerJson":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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}