Trendsic Platform Service

<back to all web services

FieldLogSubmitRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/fieldlog/submit
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 FieldLogSubmitResponse:
    response_status: Optional[ResponseStatus] = None
    field_log_id: int = 0
    field_log_u_i_d: Optional[str] = None
    status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FieldLogCrew:
    contact_id: int = 0
    status_code: Optional[str] = None
    hours: float = 0.0
    cost_code: Optional[str] = None
    split_cost_code: Optional[str] = None
    split_hours: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FieldLogEquipment:
    equipment_id: int = 0
    equipment_key: Optional[str] = None
    status_code: Optional[str] = None
    engine_hours: float = 0.0
    fuel_gallons: float = 0.0
    idle_reason: Optional[str] = None
    down_note: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FieldLogSub:
    contact_id: int = 0
    name: Optional[str] = None
    trade: Optional[str] = None
    head_count: int = 0
    hours_per: float = 0.0
    source_code: Optional[str] = None
    reporter: Optional[str] = None
    note: Optional[str] = None
    verified: bool = False
    state_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FieldLogQuantity:
    pay_item_code: Optional[str] = None
    name: Optional[str] = None
    unit: Optional[str] = None
    today_qty: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FieldLogDelivery:
    po: Optional[str] = None
    material: Optional[str] = None
    status_code: Optional[str] = None
    qty_received: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FieldLogConsumed:
    name: Optional[str] = None
    qty: Optional[str] = None
    use: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FieldLogSubmitRequest:
    project_id: int = 0
    job_id: int = 0
    log_date: Optional[str] = None
    notes: Optional[str] = None
    weather: Optional[str] = None
    temp_f: int = 0
    weather_delay_hours: float = 0.0
    toolbox_talk: Optional[str] = None
    incident_occurred: bool = False
    incident_type: Optional[str] = None
    incident_note: Optional[str] = None
    incident_photo_count: int = 0
    crew: List[FieldLogCrew] = field(default_factory=list)
    equipment: List[FieldLogEquipment] = field(default_factory=list)
    subs: List[FieldLogSub] = field(default_factory=list)
    quantities: List[FieldLogQuantity] = field(default_factory=list)
    deliveries: List[FieldLogDelivery] = field(default_factory=list)
    consumed: List[FieldLogConsumed] = field(default_factory=list)

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

<FieldLogSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Consumed>
    <FieldLogConsumed>
      <Name>String</Name>
      <Qty>String</Qty>
      <Use>String</Use>
    </FieldLogConsumed>
  </Consumed>
  <Crew>
    <FieldLogCrew>
      <ContactId>0</ContactId>
      <CostCode>String</CostCode>
      <Hours>0</Hours>
      <SplitCostCode>String</SplitCostCode>
      <SplitHours>0</SplitHours>
      <StatusCode>String</StatusCode>
    </FieldLogCrew>
  </Crew>
  <Deliveries>
    <FieldLogDelivery>
      <Material>String</Material>
      <Po>String</Po>
      <QtyReceived>String</QtyReceived>
      <StatusCode>String</StatusCode>
    </FieldLogDelivery>
  </Deliveries>
  <Equipment>
    <FieldLogEquipment>
      <DownNote>String</DownNote>
      <EngineHours>0</EngineHours>
      <EquipmentId>0</EquipmentId>
      <EquipmentKey>String</EquipmentKey>
      <FuelGallons>0</FuelGallons>
      <IdleReason>String</IdleReason>
      <StatusCode>String</StatusCode>
    </FieldLogEquipment>
  </Equipment>
  <IncidentNote>String</IncidentNote>
  <IncidentOccurred>false</IncidentOccurred>
  <IncidentPhotoCount>0</IncidentPhotoCount>
  <IncidentType>String</IncidentType>
  <JobId>0</JobId>
  <LogDate>String</LogDate>
  <Notes>String</Notes>
  <ProjectId>0</ProjectId>
  <Quantities>
    <FieldLogQuantity>
      <Name>String</Name>
      <PayItemCode>String</PayItemCode>
      <TodayQty>0</TodayQty>
      <Unit>String</Unit>
    </FieldLogQuantity>
  </Quantities>
  <Subs>
    <FieldLogSub>
      <ContactId>0</ContactId>
      <HeadCount>0</HeadCount>
      <HoursPer>0</HoursPer>
      <Name>String</Name>
      <Note>String</Note>
      <Reporter>String</Reporter>
      <SourceCode>String</SourceCode>
      <StateCode>String</StateCode>
      <Trade>String</Trade>
      <Verified>false</Verified>
    </FieldLogSub>
  </Subs>
  <TempF>0</TempF>
  <ToolboxTalk>String</ToolboxTalk>
  <Weather>String</Weather>
  <WeatherDelayHours>0</WeatherDelayHours>
</FieldLogSubmitRequest>

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

<FieldLogSubmitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FieldLogId>0</FieldLogId>
  <FieldLogUID>00000000-0000-0000-0000-000000000000</FieldLogUID>
  <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>
  <Status>String</Status>
</FieldLogSubmitResponse>