Trendsic Platform Service

<back to all web services

MarkupRaiseRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise}

export class DocumentMarkupLink
{
    public DocumentMarkupLinkID: number;
    public AttachmentId: string;
    public VersionNo: number;
    public PageIndex: number;
    public ShapeId: string;
    public EntityType: string;
    public EntityID: number;
    public EntityNo: string;
    public CreatedBy: string;
    public CreatedAt?: string;

    public constructor(init?: Partial<DocumentMarkupLink>) { (Object as any).assign(this, init); }
}

export class MarkupRaiseResponse
{
    public ResponseStatus: ResponseStatus;
    public Link: DocumentMarkupLink;
    public Links: DocumentMarkupLink[] = [];

    public constructor(init?: Partial<MarkupRaiseResponse>) { (Object as any).assign(this, init); }
}

export class MarkupRaiseRequest
{
    public AttachmentId: string;
    public VersionNo: number;
    public PageIndex: number;
    public ShapeId: string;
    public Raise: string;
    public ProjectID?: number;
    public Title: string;
    public Description: string;
    public Area: string;
    public Trade: string;
    public AssignedSub: string;
    public Priority: string;
    public AskedOf: string;
    public Discipline: string;
    public DueDate?: string;

    public constructor(init?: Partial<MarkupRaiseRequest>) { (Object as any).assign(this, init); }
}

TypeScript MarkupRaiseRequest 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.

POST /v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MarkupRaiseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Area>String</Area>
  <AskedOf>String</AskedOf>
  <AssignedSub>String</AssignedSub>
  <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
  <Description>String</Description>
  <Discipline>String</Discipline>
  <DueDate>0001-01-01T00:00:00</DueDate>
  <PageIndex>0</PageIndex>
  <Priority>String</Priority>
  <ProjectID>0</ProjectID>
  <Raise>String</Raise>
  <ShapeId>String</ShapeId>
  <Title>String</Title>
  <Trade>String</Trade>
  <VersionNo>0</VersionNo>
</MarkupRaiseRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MarkupRaiseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Link>
    <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>
  </Link>
  <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>
  <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>
</MarkupRaiseResponse>