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.*


open class MarkupPageRequest
{
    open var AttachmentId:UUID? = null
    open var VersionNo:Int? = null
    open var PageIndex:Int? = null
    open var LayerJson:String? = null
}

open class MarkupPageResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var AttachmentId:UUID? = null
    open var VersionNo:Int? = null
    open var PageIndex:Int? = null
    open var Layers:ArrayList<DocumentMarkupLayer> = ArrayList<DocumentMarkupLayer>()
    open var Links:ArrayList<DocumentMarkupLink> = ArrayList<DocumentMarkupLink>()
    open var Mine:DocumentMarkupLayer? = null
    open var CanCreatePunch:Boolean? = null
    open var CanCreateRfi:Boolean? = null
    open var ProjectID:Int? = null
}

open class DocumentMarkupLayer
{
    open var DocumentMarkupID:Int? = null
    open var AttachmentId:UUID? = null
    open var VersionNo:Int? = null
    open var PageIndex:Int? = null
    open var AuthorUserId:String? = null
    open var AuthorName:String? = null
    open var LayerJson:String? = null
    open var ShapeCount:Int? = null
    open var IsPublished:Boolean? = null
    open var CreatedAt:Date? = null
    open var UpdatedAt:Date? = null
    open var IsMine:Boolean? = null
}

open class DocumentMarkupLink
{
    open var DocumentMarkupLinkID:Int? = null
    open var AttachmentId:UUID? = null
    open var VersionNo:Int? = null
    open var PageIndex:Int? = null
    open var ShapeId:String? = null
    open var EntityType:String? = null
    open var EntityID:Int? = null
    open var EntityNo:String? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
}

Kotlin MarkupPageRequest DTOs

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

HTTP + OTHER

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

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