Trendsic Platform Service

<back to all web services

CorrectiveActionCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/safety/actions
<?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 CorrectiveAction implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CorrectiveActionID=0,
        /** @var string|null */
        public ?string $BranchId=null,
        /** @var int|null */
        public ?int $SafetyIncidentID=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Owner=null,
        /** @var DateTime|null */
        public ?DateTime $DueDate=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $Priority=null,
        /** @var DateTime|null */
        public ?DateTime $CompletedAt=null,
        /** @var string|null */
        public ?string $IncidentNo=null,
        /** @var string|null */
        public ?string $IncidentTitle=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CorrectiveActionID'])) $this->CorrectiveActionID = $o['CorrectiveActionID'];
        if (isset($o['BranchId'])) $this->BranchId = $o['BranchId'];
        if (isset($o['SafetyIncidentID'])) $this->SafetyIncidentID = $o['SafetyIncidentID'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Owner'])) $this->Owner = $o['Owner'];
        if (isset($o['DueDate'])) $this->DueDate = JsonConverters::from('DateTime', $o['DueDate']);
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['Priority'])) $this->Priority = $o['Priority'];
        if (isset($o['CompletedAt'])) $this->CompletedAt = JsonConverters::from('DateTime', $o['CompletedAt']);
        if (isset($o['IncidentNo'])) $this->IncidentNo = $o['IncidentNo'];
        if (isset($o['IncidentTitle'])) $this->IncidentTitle = $o['IncidentTitle'];
        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']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CorrectiveActionID)) $o['CorrectiveActionID'] = $this->CorrectiveActionID;
        if (isset($this->BranchId)) $o['BranchId'] = $this->BranchId;
        if (isset($this->SafetyIncidentID)) $o['SafetyIncidentID'] = $this->SafetyIncidentID;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Owner)) $o['Owner'] = $this->Owner;
        if (isset($this->DueDate)) $o['DueDate'] = JsonConverters::to('DateTime', $this->DueDate);
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->Priority)) $o['Priority'] = $this->Priority;
        if (isset($this->CompletedAt)) $o['CompletedAt'] = JsonConverters::to('DateTime', $this->CompletedAt);
        if (isset($this->IncidentNo)) $o['IncidentNo'] = $this->IncidentNo;
        if (isset($this->IncidentTitle)) $o['IncidentTitle'] = $this->IncidentTitle;
        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);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class CorrectiveActionCreateRequest implements JsonSerializable
{
    public function __construct(
        /** @var int|null */
        public ?int $SafetyIncidentID=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Owner=null,
        /** @var DateTime|null */
        public ?DateTime $DueDate=null,
        /** @var string|null */
        public ?string $Priority=null
    ) {
    }

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

PHP CorrectiveActionCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/safety/actions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"SafetyIncidentID":0,"Description":"String","Owner":"String","DueDate":"0001-01-01T00:00:00.0000000","Priority":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Actions":[{"CorrectiveActionID":0,"BranchId":"00000000000000000000000000000000","SafetyIncidentID":0,"Description":"String","Owner":"String","DueDate":"0001-01-01T00:00:00.0000000","Status":"String","Priority":"String","CompletedAt":"0001-01-01T00:00:00.0000000","IncidentNo":"String","IncidentTitle":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}]}