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