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

{
	ProjectLocationSiteDetailID: 0,
	SiteDetails: 
	[
		{
			ProjectLocationSiteDetailID: 0,
			ProjectLocationID: 0,
			DetailType: String,
			Label: String,
			Value: String,
			IsSensitive: False,
			EncVersion: 0,
			HasValue: False,
			Notes: String,
			DisplayOrder: 0,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Locations: 
	[
		{
			ProjectLocationID: 0,
			ProjectID: 0,
			Name: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			Latitude: 0,
			Longitude: 0,
			TotalArea: 0,
			AreaUnit: String,
			AccessInstructions: String,
			IsPrimary: False,
			DisplayOrder: 0,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			Areas: 
			[
				{
					ProjectLocationAreaID: 0,
					ProjectLocationID: 0,
					Name: String,
					Measurement: 0,
					MeasurementUnit: String,
					Notes: String,
					DisplayOrder: 0,
					Active: False,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					UpdatedAt: 0001-01-01
				}
			],
			Equipment: 
			[
				{
					ProjectLocationEquipmentID: 0,
					ProjectLocationID: 0,
					Name: String,
					Description: String,
					Manufacturer: String,
					Model: String,
					SerialNumber: String,
					AssetTag: String,
					Notes: String,
					Active: False,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					UpdatedAt: 0001-01-01
				}
			],
			SiteDetails: 
			[
				{
					ProjectLocationSiteDetailID: 0,
					ProjectLocationID: 0,
					DetailType: String,
					Label: String,
					Value: String,
					IsSensitive: False,
					EncVersion: 0,
					HasValue: False,
					Notes: String,
					DisplayOrder: 0,
					Active: False,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					UpdatedAt: 0001-01-01
				}
			],
			Attachments: 
			[
				{
					ProjectLocationAttachmentID: 0,
					ProjectLocationID: 0,
					ProjectLocationAreaID: 0,
					Kind: String,
					DocTitle: String,
					FileName: String,
					Url: String,
					MimeType: String,
					UploadDate: 0001-01-01,
					UploadedBy: String,
					Active: False
				}
			]
		}
	],
	Areas: 
	[
		{
			ProjectLocationAreaID: 0,
			ProjectLocationID: 0,
			Name: String,
			Measurement: 0,
			MeasurementUnit: String,
			Notes: String,
			DisplayOrder: 0,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	Equipment: 
	[
		{
			ProjectLocationEquipmentID: 0,
			ProjectLocationID: 0,
			Name: String,
			Description: String,
			Manufacturer: String,
			Model: String,
			SerialNumber: String,
			AssetTag: String,
			Notes: String,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	SiteDetails: 
	[
		{
			ProjectLocationSiteDetailID: 0,
			ProjectLocationID: 0,
			DetailType: String,
			Label: String,
			Value: String,
			IsSensitive: False,
			EncVersion: 0,
			HasValue: False,
			Notes: String,
			DisplayOrder: 0,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	Attachments: 
	[
		{
			ProjectLocationAttachmentID: 0,
			ProjectLocationID: 0,
			ProjectLocationAreaID: 0,
			Kind: String,
			DocTitle: String,
			FileName: String,
			Url: String,
			MimeType: String,
			UploadDate: 0001-01-01,
			UploadedBy: String,
			Active: False
		}
	],
	SiteDetail: 
	{
		ProjectLocationSiteDetailID: 0,
		ProjectLocationID: 0,
		DetailType: String,
		Label: String,
		Value: String,
		IsSensitive: False,
		EncVersion: 0,
		HasValue: False,
		Notes: String,
		DisplayOrder: 0,
		Active: False,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}