Trendsic Platform Service

<back to all web services

SafetyComplianceRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/safety/compliance
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class SafetyComplianceKpis implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ParticipationPct=0,
        /** @var int */
        public int $OpenIncidents=0,
        /** @var int */
        public int $OverdueCAs=0,
        /** @var int */
        public int $Recordables12mo=0,
        /** @var int */
        public int $DaysWithoutRecordable=0,
        /** @var int */
        public int $ProjectsWithTalkToday=0,
        /** @var int */
        public int $ProjectsWithCrewToday=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ParticipationPct'])) $this->ParticipationPct = $o['ParticipationPct'];
        if (isset($o['OpenIncidents'])) $this->OpenIncidents = $o['OpenIncidents'];
        if (isset($o['OverdueCAs'])) $this->OverdueCAs = $o['OverdueCAs'];
        if (isset($o['Recordables12mo'])) $this->Recordables12mo = $o['Recordables12mo'];
        if (isset($o['DaysWithoutRecordable'])) $this->DaysWithoutRecordable = $o['DaysWithoutRecordable'];
        if (isset($o['ProjectsWithTalkToday'])) $this->ProjectsWithTalkToday = $o['ProjectsWithTalkToday'];
        if (isset($o['ProjectsWithCrewToday'])) $this->ProjectsWithCrewToday = $o['ProjectsWithCrewToday'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ParticipationPct)) $o['ParticipationPct'] = $this->ParticipationPct;
        if (isset($this->OpenIncidents)) $o['OpenIncidents'] = $this->OpenIncidents;
        if (isset($this->OverdueCAs)) $o['OverdueCAs'] = $this->OverdueCAs;
        if (isset($this->Recordables12mo)) $o['Recordables12mo'] = $this->Recordables12mo;
        if (isset($this->DaysWithoutRecordable)) $o['DaysWithoutRecordable'] = $this->DaysWithoutRecordable;
        if (isset($this->ProjectsWithTalkToday)) $o['ProjectsWithTalkToday'] = $this->ProjectsWithTalkToday;
        if (isset($this->ProjectsWithCrewToday)) $o['ProjectsWithCrewToday'] = $this->ProjectsWithCrewToday;
        return empty($o) ? new class(){} : $o;
    }
}

class SafetyComplianceProject implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ProjectID=0,
        /** @var string|null */
        public ?string $ProjectUID=null,
        /** @var string|null */
        public ?string $ProjectName=null,
        /** @var string|null */
        public ?string $Branch=null,
        /** @var int */
        public int $CrewCount=0,
        /** @var bool|null */
        public ?bool $HasTalkToday=null,
        /** @var int */
        public int $TalkAckPct=0,
        /** @var int */
        public int $OpenIncidents=0,
        /** @var int */
        public int $OverdueCAs=0,
        /** @var int */
        public int $Recordables12mo=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
        if (isset($o['ProjectUID'])) $this->ProjectUID = $o['ProjectUID'];
        if (isset($o['ProjectName'])) $this->ProjectName = $o['ProjectName'];
        if (isset($o['Branch'])) $this->Branch = $o['Branch'];
        if (isset($o['CrewCount'])) $this->CrewCount = $o['CrewCount'];
        if (isset($o['HasTalkToday'])) $this->HasTalkToday = $o['HasTalkToday'];
        if (isset($o['TalkAckPct'])) $this->TalkAckPct = $o['TalkAckPct'];
        if (isset($o['OpenIncidents'])) $this->OpenIncidents = $o['OpenIncidents'];
        if (isset($o['OverdueCAs'])) $this->OverdueCAs = $o['OverdueCAs'];
        if (isset($o['Recordables12mo'])) $this->Recordables12mo = $o['Recordables12mo'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
        if (isset($this->ProjectUID)) $o['ProjectUID'] = $this->ProjectUID;
        if (isset($this->ProjectName)) $o['ProjectName'] = $this->ProjectName;
        if (isset($this->Branch)) $o['Branch'] = $this->Branch;
        if (isset($this->CrewCount)) $o['CrewCount'] = $this->CrewCount;
        if (isset($this->HasTalkToday)) $o['HasTalkToday'] = $this->HasTalkToday;
        if (isset($this->TalkAckPct)) $o['TalkAckPct'] = $this->TalkAckPct;
        if (isset($this->OpenIncidents)) $o['OpenIncidents'] = $this->OpenIncidents;
        if (isset($this->OverdueCAs)) $o['OverdueCAs'] = $this->OverdueCAs;
        if (isset($this->Recordables12mo)) $o['Recordables12mo'] = $this->Recordables12mo;
        return empty($o) ? new class(){} : $o;
    }
}

class SafetyTrendWeek implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $WeekStart=null,
        /** @var int */
        public int $Acks=0,
        /** @var int */
        public int $Roster=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['WeekStart'])) $this->WeekStart = $o['WeekStart'];
        if (isset($o['Acks'])) $this->Acks = $o['Acks'];
        if (isset($o['Roster'])) $this->Roster = $o['Roster'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->WeekStart)) $o['WeekStart'] = $this->WeekStart;
        if (isset($this->Acks)) $o['Acks'] = $this->Acks;
        if (isset($this->Roster)) $o['Roster'] = $this->Roster;
        return empty($o) ? new class(){} : $o;
    }
}

class SafetyIncidentMixRow implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Severity=null,
        /** @var int */
        public int $Cnt=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Severity'])) $this->Severity = $o['Severity'];
        if (isset($o['Cnt'])) $this->Cnt = $o['Cnt'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Severity)) $o['Severity'] = $this->Severity;
        if (isset($this->Cnt)) $o['Cnt'] = $this->Cnt;
        return empty($o) ? new class(){} : $o;
    }
}

class SafetyMissingTalk implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ProjectID=0,
        /** @var string|null */
        public ?string $ProjectUID=null,
        /** @var string|null */
        public ?string $ProjectName=null,
        /** @var int */
        public int $CrewCount=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
        if (isset($o['ProjectUID'])) $this->ProjectUID = $o['ProjectUID'];
        if (isset($o['ProjectName'])) $this->ProjectName = $o['ProjectName'];
        if (isset($o['CrewCount'])) $this->CrewCount = $o['CrewCount'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
        if (isset($this->ProjectUID)) $o['ProjectUID'] = $this->ProjectUID;
        if (isset($this->ProjectName)) $o['ProjectName'] = $this->ProjectName;
        if (isset($this->CrewCount)) $o['CrewCount'] = $this->CrewCount;
        return empty($o) ? new class(){} : $o;
    }
}

class SafetyComplianceResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var SafetyComplianceKpis|null */
        public ?SafetyComplianceKpis $Kpis=null,
        /** @var array<SafetyComplianceProject>|null */
        public ?array $Projects=null,
        /** @var array<SafetyTrendWeek>|null */
        public ?array $Trend=null,
        /** @var array<SafetyIncidentMixRow>|null */
        public ?array $IncidentMix=null,
        /** @var array<SafetyMissingTalk>|null */
        public ?array $MissingTalks=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Kpis'])) $this->Kpis = JsonConverters::from('SafetyComplianceKpis', $o['Kpis']);
        if (isset($o['Projects'])) $this->Projects = JsonConverters::fromArray('SafetyComplianceProject', $o['Projects']);
        if (isset($o['Trend'])) $this->Trend = JsonConverters::fromArray('SafetyTrendWeek', $o['Trend']);
        if (isset($o['IncidentMix'])) $this->IncidentMix = JsonConverters::fromArray('SafetyIncidentMixRow', $o['IncidentMix']);
        if (isset($o['MissingTalks'])) $this->MissingTalks = JsonConverters::fromArray('SafetyMissingTalk', $o['MissingTalks']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Kpis)) $o['Kpis'] = JsonConverters::to('SafetyComplianceKpis', $this->Kpis);
        if (isset($this->Projects)) $o['Projects'] = JsonConverters::toArray('SafetyComplianceProject', $this->Projects);
        if (isset($this->Trend)) $o['Trend'] = JsonConverters::toArray('SafetyTrendWeek', $this->Trend);
        if (isset($this->IncidentMix)) $o['IncidentMix'] = JsonConverters::toArray('SafetyIncidentMixRow', $this->IncidentMix);
        if (isset($this->MissingTalks)) $o['MissingTalks'] = JsonConverters::toArray('SafetyMissingTalk', $this->MissingTalks);
        return empty($o) ? new class(){} : $o;
    }
}

class SafetyComplianceRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Days=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Days'])) $this->Days = $o['Days'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Days)) $o['Days'] = $this->Days;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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>