Trendsic Platform Service

MarkupPageRequest

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

import Foundation
import ServiceStack

public class MarkupPageRequest : Codable
{
    public var attachmentId:String
    public var versionNo:Int
    public var pageIndex:Int
    public var layerJson:String

    required public init(){}
}

public class MarkupPageResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var attachmentId:String
    public var versionNo:Int
    public var pageIndex:Int
    public var layers:[DocumentMarkupLayer] = []
    public var links:[DocumentMarkupLink] = []
    public var mine:DocumentMarkupLayer
    public var canCreatePunch:Bool
    public var canCreateRfi:Bool
    public var projectID:Int?

    required public init(){}
}

public class DocumentMarkupLayer : Codable
{
    public var documentMarkupID:Int
    public var attachmentId:String
    public var versionNo:Int
    public var pageIndex:Int
    public var authorUserId:String
    public var authorName:String
    public var layerJson:String
    public var shapeCount:Int
    public var isPublished:Bool
    public var createdAt:Date?
    public var updatedAt:Date?
    public var isMine:Bool

    required public init(){}
}

public class DocumentMarkupLink : Codable
{
    public var documentMarkupLinkID:Int
    public var attachmentId:String
    public var versionNo:Int
    public var pageIndex:Int
    public var shapeId:String
    public var entityType:String
    public var entityID:Int
    public var entityNo:String
    public var createdBy:String
    public var createdAt:Date?

    required public init(){}
}

Swift 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>