Trendsic Platform Service

PinsForEntityRequest

The following routes are available for this service:
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 .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.

GET /v1/pins/{EntityType}/{EntityID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SheetPinListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Pins>
    <SheetPin>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <EntityID>0</EntityID>
      <EntityNo>String</EntityNo>
      <EntityStatus>String</EntityStatus>
      <EntityTitle>String</EntityTitle>
      <EntityType>String</EntityType>
      <EntityUID>00000000-0000-0000-0000-000000000000</EntityUID>
      <InspectionUID>00000000-0000-0000-0000-000000000000</InspectionUID>
      <Label>String</Label>
      <PlanSetID>0</PlanSetID>
      <PlanSetName>String</PlanSetName>
      <PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
      <SheetID>0</SheetID>
      <SheetNumber>String</SheetNumber>
      <SheetPinID>0</SheetPinID>
      <SheetTitle>String</SheetTitle>
      <X>0</X>
      <Y>0</Y>
    </SheetPin>
  </Pins>
  <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>
</SheetPinListResponse>