Trendsic Platform Service

MarkupPageRequest

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 .xml suffix or ?format=xml

HTTP + 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>