| GET,OPTIONS | /v1/pins/{EntityType}/{EntityID} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/pins/{EntityType} |
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 SheetPin:
sheet_pin_i_d: int = 0
sheet_i_d: int = 0
entity_type: Optional[str] = None
entity_i_d: Optional[int] = None
entity_u_i_d: Optional[str] = None
x: float = 0.0
y: float = 0.0
label: Optional[str] = None
created_by: Optional[str] = None
created_at: Optional[datetime.datetime] = None
entity_no: Optional[str] = None
entity_title: Optional[str] = None
entity_status: Optional[str] = None
inspection_u_i_d: Optional[str] = None
sheet_number: Optional[str] = None
sheet_title: Optional[str] = None
plan_set_i_d: Optional[int] = None
plan_set_u_i_d: Optional[str] = None
plan_set_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SheetPinListResponse:
response_status: Optional[ResponseStatus] = None
pins: List[SheetPin] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PinsForEntityRequest:
entity_type: Optional[str] = None
entity_i_d: Optional[int] = None
entity_u_i_d: Optional[str] = None
Python PinsForEntityRequest DTOs
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.
GET /v1/pins/{EntityType}/{EntityID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
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
}
},
Pins:
[
{
SheetPinID: 0,
SheetID: 0,
EntityType: String,
EntityID: 0,
EntityUID: 00000000000000000000000000000000,
X: 0,
Y: 0,
Label: String,
CreatedBy: String,
CreatedAt: 0001-01-01,
EntityNo: String,
EntityTitle: String,
EntityStatus: String,
InspectionUID: 00000000000000000000000000000000,
SheetNumber: String,
SheetTitle: String,
PlanSetID: 0,
PlanSetUID: 00000000000000000000000000000000,
PlanSetName: String
}
]
}