Trendsic Platform Service

<back to all web services

SafetyComplianceRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/safety/compliance
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 SafetyComplianceKpis:
    participation_pct: int = 0
    open_incidents: int = 0
    overdue_c_as: int = 0
    recordables12mo: int = 0
    days_without_recordable: int = 0
    projects_with_talk_today: int = 0
    projects_with_crew_today: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SafetyComplianceProject:
    project_i_d: int = 0
    project_u_i_d: Optional[str] = None
    project_name: Optional[str] = None
    branch: Optional[str] = None
    crew_count: int = 0
    has_talk_today: bool = False
    talk_ack_pct: int = 0
    open_incidents: int = 0
    overdue_c_as: int = 0
    recordables12mo: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SafetyTrendWeek:
    week_start: Optional[str] = None
    acks: int = 0
    roster: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SafetyIncidentMixRow:
    severity: Optional[str] = None
    cnt: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SafetyMissingTalk:
    project_i_d: int = 0
    project_u_i_d: Optional[str] = None
    project_name: Optional[str] = None
    crew_count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SafetyComplianceResponse:
    response_status: Optional[ResponseStatus] = None
    kpis: Optional[SafetyComplianceKpis] = None
    projects: List[SafetyComplianceProject] = field(default_factory=list)
    trend: List[SafetyTrendWeek] = field(default_factory=list)
    incident_mix: List[SafetyIncidentMixRow] = field(default_factory=list)
    missing_talks: List[SafetyMissingTalk] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SafetyComplianceRequest:
    days: int = 0

Python SafetyComplianceRequest 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/safety/compliance HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SafetyComplianceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <IncidentMix>
    <SafetyIncidentMixRow>
      <Cnt>0</Cnt>
      <Severity>String</Severity>
    </SafetyIncidentMixRow>
  </IncidentMix>
  <Kpis>
    <DaysWithoutRecordable>0</DaysWithoutRecordable>
    <OpenIncidents>0</OpenIncidents>
    <OverdueCAs>0</OverdueCAs>
    <ParticipationPct>0</ParticipationPct>
    <ProjectsWithCrewToday>0</ProjectsWithCrewToday>
    <ProjectsWithTalkToday>0</ProjectsWithTalkToday>
    <Recordables12mo>0</Recordables12mo>
  </Kpis>
  <MissingTalks>
    <SafetyMissingTalk>
      <CrewCount>0</CrewCount>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <ProjectUID>String</ProjectUID>
    </SafetyMissingTalk>
  </MissingTalks>
  <Projects>
    <SafetyComplianceProject>
      <Branch>String</Branch>
      <CrewCount>0</CrewCount>
      <HasTalkToday>false</HasTalkToday>
      <OpenIncidents>0</OpenIncidents>
      <OverdueCAs>0</OverdueCAs>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <ProjectUID>String</ProjectUID>
      <Recordables12mo>0</Recordables12mo>
      <TalkAckPct>0</TalkAckPct>
    </SafetyComplianceProject>
  </Projects>
  <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>
  <Trend>
    <SafetyTrendWeek>
      <Acks>0</Acks>
      <Roster>0</Roster>
      <WeekStart>String</WeekStart>
    </SafetyTrendWeek>
  </Trend>
</SafetyComplianceResponse>