| GET,PUT,OPTIONS | /v1/markup/{AttachmentId}/{VersionNo}/{PageIndex} |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;
namespace CRM.AgencyPlatform.API.Internal
{
public partial class DocumentMarkupLayer
{
public virtual int DocumentMarkupID { get; set; }
public virtual Guid AttachmentId { get; set; }
public virtual int VersionNo { get; set; }
public virtual int PageIndex { get; set; }
public virtual string AuthorUserId { get; set; }
public virtual string AuthorName { get; set; }
public virtual string LayerJson { get; set; }
public virtual int ShapeCount { get; set; }
public virtual bool IsPublished { get; set; }
public virtual DateTime? CreatedAt { get; set; }
public virtual DateTime? UpdatedAt { get; set; }
public virtual bool IsMine { get; set; }
}
public partial class DocumentMarkupLink
{
public virtual int DocumentMarkupLinkID { get; set; }
public virtual Guid AttachmentId { get; set; }
public virtual int VersionNo { get; set; }
public virtual int PageIndex { get; set; }
public virtual string ShapeId { get; set; }
public virtual string EntityType { get; set; }
public virtual int EntityID { get; set; }
public virtual string EntityNo { get; set; }
public virtual string CreatedBy { get; set; }
public virtual DateTime? CreatedAt { get; set; }
}
public partial class MarkupPageRequest
{
public virtual Guid AttachmentId { get; set; }
public virtual int VersionNo { get; set; }
public virtual int PageIndex { get; set; }
public virtual string LayerJson { get; set; }
}
public partial class MarkupPageResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual Guid AttachmentId { get; set; }
public virtual int VersionNo { get; set; }
public virtual int PageIndex { get; set; }
public virtual List<DocumentMarkupLayer> Layers { get; set; } = [];
public virtual List<DocumentMarkupLink> Links { get; set; } = [];
public virtual DocumentMarkupLayer Mine { get; set; }
public virtual bool CanCreatePunch { get; set; }
public virtual bool CanCreateRfi { get; set; }
public virtual int? ProjectID { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
AttachmentId: 00000000000000000000000000000000,
VersionNo: 0,
PageIndex: 0,
LayerJson: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
UpdatedAt: 0001-01-01,
IsMine: False
}
],
Links:
[
{
DocumentMarkupLinkID: 0,
AttachmentId: 00000000000000000000000000000000,
VersionNo: 0,
PageIndex: 0,
ShapeId: String,
EntityType: String,
EntityID: 0,
EntityNo: String,
CreatedBy: String,
CreatedAt: 0001-01-01
}
],
Mine:
{
DocumentMarkupID: 0,
AttachmentId: 00000000000000000000000000000000,
VersionNo: 0,
PageIndex: 0,
AuthorUserId: String,
AuthorName: String,
LayerJson: String,
ShapeCount: 0,
IsPublished: False,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01,
IsMine: False
},
CanCreatePunch: False,
CanCreateRfi: False,
ProjectID: 0
}