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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AttachmentId: 00000000000000000000000000000000,
	VersionNo: 0,
	PageIndex: 0,
	ShapeId: String,
	Raise: String,
	ProjectID: 0,
	Title: String,
	Description: String,
	Area: String,
	Trade: String,
	AssignedSub: String,
	Priority: String,
	AskedOf: String,
	Discipline: String,
	DueDate: 0001-01-01
}

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
		}
	},
	Link: 
	{
		DocumentMarkupLinkID: 0,
		AttachmentId: 00000000000000000000000000000000,
		VersionNo: 0,
		PageIndex: 0,
		ShapeId: String,
		EntityType: String,
		EntityID: 0,
		EntityNo: String,
		CreatedBy: String,
		CreatedAt: 0001-01-01
	},
	Links: 
	[
		{
			DocumentMarkupLinkID: 0,
			AttachmentId: 00000000000000000000000000000000,
			VersionNo: 0,
			PageIndex: 0,
			ShapeId: String,
			EntityType: String,
			EntityID: 0,
			EntityNo: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01
		}
	]
}