Trendsic Platform Service

<back to all web services

SafetyIncidentListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/safety/incidents
<?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 SafetyIncident implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $SafetyIncidentID=0,
        /** @var string */
        public string $SafetyIncidentUID='',
        /** @var string|null */
        public ?string $BranchId=null,
        /** @var int|null */
        public ?int $ProjectID=null,
        /** @var string|null */
        public ?string $IncidentNo=null,
        /** @var string|null */
        public ?string $IncidentType=null,
        /** @var string|null */
        public ?string $Severity=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $Title=null,
        /** @var string|null */
        public ?string $Location=null,
        /** @var string|null */
        public ?string $CrewLabel=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $ReportedBy=null,
        /** @var bool|null */
        public ?bool $IsRecordable=null,
        /** @var DateTime|null */
        public ?DateTime $OccurredAt=null,
        /** @var DateTime|null */
        public ?DateTime $ClosedAt=null,
        /** @var string|null */
        public ?string $SourceRef=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null,
        /** @var int */
        public int $DaysAgo=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SafetyIncidentID'])) $this->SafetyIncidentID = $o['SafetyIncidentID'];
        if (isset($o['SafetyIncidentUID'])) $this->SafetyIncidentUID = $o['SafetyIncidentUID'];
        if (isset($o['BranchId'])) $this->BranchId = $o['BranchId'];
        if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
        if (isset($o['IncidentNo'])) $this->IncidentNo = $o['IncidentNo'];
        if (isset($o['IncidentType'])) $this->IncidentType = $o['IncidentType'];
        if (isset($o['Severity'])) $this->Severity = $o['Severity'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['Title'])) $this->Title = $o['Title'];
        if (isset($o['Location'])) $this->Location = $o['Location'];
        if (isset($o['CrewLabel'])) $this->CrewLabel = $o['CrewLabel'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['ReportedBy'])) $this->ReportedBy = $o['ReportedBy'];
        if (isset($o['IsRecordable'])) $this->IsRecordable = $o['IsRecordable'];
        if (isset($o['OccurredAt'])) $this->OccurredAt = JsonConverters::from('DateTime', $o['OccurredAt']);
        if (isset($o['ClosedAt'])) $this->ClosedAt = JsonConverters::from('DateTime', $o['ClosedAt']);
        if (isset($o['SourceRef'])) $this->SourceRef = $o['SourceRef'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
        if (isset($o['DaysAgo'])) $this->DaysAgo = $o['DaysAgo'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SafetyIncidentID)) $o['SafetyIncidentID'] = $this->SafetyIncidentID;
        if (isset($this->SafetyIncidentUID)) $o['SafetyIncidentUID'] = $this->SafetyIncidentUID;
        if (isset($this->BranchId)) $o['BranchId'] = $this->BranchId;
        if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
        if (isset($this->IncidentNo)) $o['IncidentNo'] = $this->IncidentNo;
        if (isset($this->IncidentType)) $o['IncidentType'] = $this->IncidentType;
        if (isset($this->Severity)) $o['Severity'] = $this->Severity;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->Title)) $o['Title'] = $this->Title;
        if (isset($this->Location)) $o['Location'] = $this->Location;
        if (isset($this->CrewLabel)) $o['CrewLabel'] = $this->CrewLabel;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->ReportedBy)) $o['ReportedBy'] = $this->ReportedBy;
        if (isset($this->IsRecordable)) $o['IsRecordable'] = $this->IsRecordable;
        if (isset($this->OccurredAt)) $o['OccurredAt'] = JsonConverters::to('DateTime', $this->OccurredAt);
        if (isset($this->ClosedAt)) $o['ClosedAt'] = JsonConverters::to('DateTime', $this->ClosedAt);
        if (isset($this->SourceRef)) $o['SourceRef'] = $this->SourceRef;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
        if (isset($this->DaysAgo)) $o['DaysAgo'] = $this->DaysAgo;
        return empty($o) ? new class(){} : $o;
    }
}

class SafetyIncidentListResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<SafetyIncident>|null */
        public ?array $Incidents=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Incidents'])) $this->Incidents = JsonConverters::fromArray('SafetyIncident', $o['Incidents']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Incidents)) $o['Incidents'] = JsonConverters::toArray('SafetyIncident', $this->Incidents);
        return empty($o) ? new class(){} : $o;
    }
}

class SafetyIncidentListRequest implements JsonSerializable
{
    public function __construct(
        /** @var DateTime|null */
        public ?DateTime $FromDate=null,
        /** @var DateTime|null */
        public ?DateTime $ToDate=null,
        /** @var int|null */
        public ?int $ProjectID=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['FromDate'])) $this->FromDate = JsonConverters::from('DateTime', $o['FromDate']);
        if (isset($o['ToDate'])) $this->ToDate = JsonConverters::from('DateTime', $o['ToDate']);
        if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->FromDate)) $o['FromDate'] = JsonConverters::to('DateTime', $this->FromDate);
        if (isset($this->ToDate)) $o['ToDate'] = JsonConverters::to('DateTime', $this->ToDate);
        if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
        return empty($o) ? new class(){} : $o;
    }
}

PHP SafetyIncidentListRequest 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/incidents HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<SafetyIncidentListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Incidents>
    <SafetyIncident>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <ClosedAt>0001-01-01T00:00:00</ClosedAt>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <CrewLabel>String</CrewLabel>
      <DaysAgo>0</DaysAgo>
      <Description>String</Description>
      <IncidentNo>String</IncidentNo>
      <IncidentType>String</IncidentType>
      <IsRecordable>false</IsRecordable>
      <Location>String</Location>
      <OccurredAt>0001-01-01T00:00:00</OccurredAt>
      <ProjectID>0</ProjectID>
      <ReportedBy>String</ReportedBy>
      <SafetyIncidentID>0</SafetyIncidentID>
      <SafetyIncidentUID>00000000-0000-0000-0000-000000000000</SafetyIncidentUID>
      <Severity>String</Severity>
      <SourceRef>String</SourceRef>
      <Status>String</Status>
      <Title>String</Title>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </SafetyIncident>
  </Incidents>
  <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>
</SafetyIncidentListResponse>