Trendsic Platform Service

<back to all web services

ProjectLocationSiteDetailRequest

Requires Authentication
The following routes are available for this service:
POST,PUT/v1/projectlocationsitedetail
DELETE/v1/projectlocationsitedetail/{ProjectLocationSiteDetailID}
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 ProjectLocationArea:
    project_location_area_i_d: int = 0
    project_location_i_d: int = 0
    name: Optional[str] = None
    measurement: Optional[Decimal] = None
    measurement_unit: Optional[str] = None
    notes: Optional[str] = None
    display_order: int = 0
    active: bool = False
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectLocationEquipment:
    project_location_equipment_i_d: int = 0
    project_location_i_d: int = 0
    name: Optional[str] = None
    description: Optional[str] = None
    manufacturer: Optional[str] = None
    model: Optional[str] = None
    serial_number: Optional[str] = None
    asset_tag: Optional[str] = None
    notes: Optional[str] = None
    active: bool = False
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectLocationSiteDetail:
    project_location_site_detail_i_d: int = 0
    project_location_i_d: int = 0
    detail_type: Optional[str] = None
    label: Optional[str] = None
    value: Optional[str] = None
    is_sensitive: bool = False
    enc_version: int = 0
    has_value: bool = False
    notes: Optional[str] = None
    display_order: int = 0
    active: bool = False
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectLocationAttachment:
    project_location_attachment_i_d: int = 0
    project_location_i_d: int = 0
    project_location_area_i_d: Optional[int] = None
    kind: Optional[str] = None
    doc_title: Optional[str] = None
    file_name: Optional[str] = None
    url: Optional[str] = None
    mime_type: Optional[str] = None
    upload_date: Optional[datetime.datetime] = None
    uploaded_by: Optional[str] = None
    active: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectLocation:
    project_location_i_d: int = 0
    project_i_d: int = 0
    name: Optional[str] = None
    address1: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    zip: Optional[str] = None
    latitude: Optional[Decimal] = None
    longitude: Optional[Decimal] = None
    total_area: Optional[Decimal] = None
    area_unit: Optional[str] = None
    access_instructions: Optional[str] = None
    is_primary: bool = False
    display_order: int = 0
    active: bool = False
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None
    areas: List[ProjectLocationArea] = field(default_factory=list)
    equipment: List[ProjectLocationEquipment] = field(default_factory=list)
    site_details: List[ProjectLocationSiteDetail] = field(default_factory=list)
    attachments: List[ProjectLocationAttachment] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectLocationResponse:
    locations: List[ProjectLocation] = field(default_factory=list)
    areas: List[ProjectLocationArea] = field(default_factory=list)
    equipment: List[ProjectLocationEquipment] = field(default_factory=list)
    site_details: List[ProjectLocationSiteDetail] = field(default_factory=list)
    attachments: List[ProjectLocationAttachment] = field(default_factory=list)
    site_detail: Optional[ProjectLocationSiteDetail] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectLocationSiteDetailRequest:
    project_location_site_detail_i_d: int = 0
    site_details: List[ProjectLocationSiteDetail] = field(default_factory=list)

Python ProjectLocationSiteDetailRequest 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/projectlocationsitedetail HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProjectLocationSiteDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ProjectLocationSiteDetailID>0</ProjectLocationSiteDetailID>
  <SiteDetails>
    <ProjectLocationSiteDetail>
      <Active>false</Active>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DetailType>String</DetailType>
      <DisplayOrder>0</DisplayOrder>
      <EncVersion>0</EncVersion>
      <HasValue>false</HasValue>
      <IsSensitive>false</IsSensitive>
      <Label>String</Label>
      <Notes>String</Notes>
      <ProjectLocationID>0</ProjectLocationID>
      <ProjectLocationSiteDetailID>0</ProjectLocationSiteDetailID>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <Value>String</Value>
    </ProjectLocationSiteDetail>
  </SiteDetails>
</ProjectLocationSiteDetailRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectLocationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Areas>
    <ProjectLocationArea>
      <Active>false</Active>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DisplayOrder>0</DisplayOrder>
      <Measurement>0</Measurement>
      <MeasurementUnit>String</MeasurementUnit>
      <Name>String</Name>
      <Notes>String</Notes>
      <ProjectLocationAreaID>0</ProjectLocationAreaID>
      <ProjectLocationID>0</ProjectLocationID>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </ProjectLocationArea>
  </Areas>
  <Attachments>
    <ProjectLocationAttachment>
      <Active>false</Active>
      <DocTitle>String</DocTitle>
      <FileName>String</FileName>
      <Kind>String</Kind>
      <MimeType>String</MimeType>
      <ProjectLocationAreaID>0</ProjectLocationAreaID>
      <ProjectLocationAttachmentID>0</ProjectLocationAttachmentID>
      <ProjectLocationID>0</ProjectLocationID>
      <UploadDate>0001-01-01T00:00:00</UploadDate>
      <UploadedBy>String</UploadedBy>
      <Url>String</Url>
    </ProjectLocationAttachment>
  </Attachments>
  <Equipment>
    <ProjectLocationEquipment>
      <Active>false</Active>
      <AssetTag>String</AssetTag>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Description>String</Description>
      <Manufacturer>String</Manufacturer>
      <Model>String</Model>
      <Name>String</Name>
      <Notes>String</Notes>
      <ProjectLocationEquipmentID>0</ProjectLocationEquipmentID>
      <ProjectLocationID>0</ProjectLocationID>
      <SerialNumber>String</SerialNumber>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </ProjectLocationEquipment>
  </Equipment>
  <Locations>
    <ProjectLocation>
      <AccessInstructions>String</AccessInstructions>
      <Active>false</Active>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <AreaUnit>String</AreaUnit>
      <Areas>
        <ProjectLocationArea>
          <Active>false</Active>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <DisplayOrder>0</DisplayOrder>
          <Measurement>0</Measurement>
          <MeasurementUnit>String</MeasurementUnit>
          <Name>String</Name>
          <Notes>String</Notes>
          <ProjectLocationAreaID>0</ProjectLocationAreaID>
          <ProjectLocationID>0</ProjectLocationID>
          <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
        </ProjectLocationArea>
      </Areas>
      <Attachments>
        <ProjectLocationAttachment>
          <Active>false</Active>
          <DocTitle>String</DocTitle>
          <FileName>String</FileName>
          <Kind>String</Kind>
          <MimeType>String</MimeType>
          <ProjectLocationAreaID>0</ProjectLocationAreaID>
          <ProjectLocationAttachmentID>0</ProjectLocationAttachmentID>
          <ProjectLocationID>0</ProjectLocationID>
          <UploadDate>0001-01-01T00:00:00</UploadDate>
          <UploadedBy>String</UploadedBy>
          <Url>String</Url>
        </ProjectLocationAttachment>
      </Attachments>
      <City>String</City>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DisplayOrder>0</DisplayOrder>
      <Equipment>
        <ProjectLocationEquipment>
          <Active>false</Active>
          <AssetTag>String</AssetTag>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <Description>String</Description>
          <Manufacturer>String</Manufacturer>
          <Model>String</Model>
          <Name>String</Name>
          <Notes>String</Notes>
          <ProjectLocationEquipmentID>0</ProjectLocationEquipmentID>
          <ProjectLocationID>0</ProjectLocationID>
          <SerialNumber>String</SerialNumber>
          <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
        </ProjectLocationEquipment>
      </Equipment>
      <IsPrimary>false</IsPrimary>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <Name>String</Name>
      <ProjectID>0</ProjectID>
      <ProjectLocationID>0</ProjectLocationID>
      <SiteDetails>
        <ProjectLocationSiteDetail>
          <Active>false</Active>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <DetailType>String</DetailType>
          <DisplayOrder>0</DisplayOrder>
          <EncVersion>0</EncVersion>
          <HasValue>false</HasValue>
          <IsSensitive>false</IsSensitive>
          <Label>String</Label>
          <Notes>String</Notes>
          <ProjectLocationID>0</ProjectLocationID>
          <ProjectLocationSiteDetailID>0</ProjectLocationSiteDetailID>
          <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
          <Value>String</Value>
        </ProjectLocationSiteDetail>
      </SiteDetails>
      <State>String</State>
      <TotalArea>0</TotalArea>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <Zip>String</Zip>
    </ProjectLocation>
  </Locations>
  <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>
  <SiteDetail>
    <Active>false</Active>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <DetailType>String</DetailType>
    <DisplayOrder>0</DisplayOrder>
    <EncVersion>0</EncVersion>
    <HasValue>false</HasValue>
    <IsSensitive>false</IsSensitive>
    <Label>String</Label>
    <Notes>String</Notes>
    <ProjectLocationID>0</ProjectLocationID>
    <ProjectLocationSiteDetailID>0</ProjectLocationSiteDetailID>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <Value>String</Value>
  </SiteDetail>
  <SiteDetails>
    <ProjectLocationSiteDetail>
      <Active>false</Active>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DetailType>String</DetailType>
      <DisplayOrder>0</DisplayOrder>
      <EncVersion>0</EncVersion>
      <HasValue>false</HasValue>
      <IsSensitive>false</IsSensitive>
      <Label>String</Label>
      <Notes>String</Notes>
      <ProjectLocationID>0</ProjectLocationID>
      <ProjectLocationSiteDetailID>0</ProjectLocationSiteDetailID>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <Value>String</Value>
    </ProjectLocationSiteDetail>
  </SiteDetails>
</ProjectLocationResponse>