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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DocumentMarkupLayer
            Public Overridable Property DocumentMarkupID As Integer
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property VersionNo As Integer
            Public Overridable Property PageIndex As Integer
            Public Overridable Property AuthorUserId As String
            Public Overridable Property AuthorName As String
            Public Overridable Property LayerJson As String
            Public Overridable Property ShapeCount As Integer
            Public Overridable Property IsPublished As Boolean
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property UpdatedAt As Date?
            Public Overridable Property IsMine As Boolean
        End Class

        Public Partial Class DocumentMarkupLink
            Public Overridable Property DocumentMarkupLinkID As Integer
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property VersionNo As Integer
            Public Overridable Property PageIndex As Integer
            Public Overridable Property ShapeId As String
            Public Overridable Property EntityType As String
            Public Overridable Property EntityID As Integer
            Public Overridable Property EntityNo As String
            Public Overridable Property CreatedBy As String
            Public Overridable Property CreatedAt As Date?
        End Class

        Public Partial Class MarkupPageRequest
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property VersionNo As Integer
            Public Overridable Property PageIndex As Integer
            Public Overridable Property LayerJson As String
        End Class

        Public Partial Class MarkupPageResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property VersionNo As Integer
            Public Overridable Property PageIndex As Integer
            Public Overridable Property Layers As List(Of DocumentMarkupLayer) = New List(Of DocumentMarkupLayer)
            Public Overridable Property Links As List(Of DocumentMarkupLink) = New List(Of DocumentMarkupLink)
            Public Overridable Property Mine As DocumentMarkupLayer
            Public Overridable Property CanCreatePunch As Boolean
            Public Overridable Property CanCreateRfi As Boolean
            Public Overridable Property ProjectID As Integer?
        End Class
    End Namespace
End Namespace

VB.NET MarkupPageRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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