Trendsic Platform Service

MarkupRaiseRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentMarkupLink:
    document_markup_link_i_d: int = 0
    attachment_id: Optional[str] = None
    version_no: int = 0
    page_index: int = 0
    shape_id: Optional[str] = None
    entity_type: Optional[str] = None
    entity_i_d: int = 0
    entity_no: Optional[str] = None
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MarkupRaiseResponse:
    response_status: Optional[ResponseStatus] = None
    link: Optional[DocumentMarkupLink] = None
    links: List[DocumentMarkupLink] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MarkupRaiseRequest:
    attachment_id: Optional[str] = None
    version_no: int = 0
    page_index: int = 0
    shape_id: Optional[str] = None
    raise_: Optional[str] = field(metadata=config(field_name='raise'), default=None)
    project_i_d: Optional[int] = None
    title: Optional[str] = None
    description: Optional[str] = None
    area: Optional[str] = None
    trade: Optional[str] = None
    assigned_sub: Optional[str] = None
    priority: Optional[str] = None
    asked_of: Optional[str] = None
    discipline: Optional[str] = None
    due_date: Optional[datetime.datetime] = None

Python 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>