Trendsic Platform Service

<back to all web services

AuditCheckins

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/AuditCheckins/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/AuditCheckins
<?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 AuditCheckinObject implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Id='',
        /** @var string */
        public string $CustomCheckinId='',
        /** @var int */
        public int $StatusId=0,
        /** @var DateTime */
        public DateTime $ModDate=new DateTime(),
        /** @var string */
        public string $ModBy=''
    ) {
    }

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

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

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

class AuditCheckins extends AuditCheckinObject implements JsonSerializable
{
    /**
     * @param string $Id
     * @param string $CustomCheckinId
     * @param int $StatusId
     * @param DateTime $ModDate
     * @param string $ModBy
     */
    public function __construct(
        string $Id='',
        string $CustomCheckinId='',
        int $StatusId=0,
        DateTime $ModDate=new DateTime(),
        string $ModBy='',
        /** @var string */
        public string $ApiKey=''
    ) {
        parent::__construct($Id,$CustomCheckinId,$StatusId,$ModDate,$ModBy);
    }

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

PHP AuditCheckins 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/AuditCheckins/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ApiKey":"00000000000000000000000000000000","Id":"00000000000000000000000000000000","CustomCheckinId":"00000000000000000000000000000000","StatusId":0,"ModDate":"0001-01-01T00:00:00.0000000","ModBy":"00000000000000000000000000000000"}
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"}},"AuditCheckins":[{"Id":"00000000000000000000000000000000","CustomCheckinId":"00000000000000000000000000000000","StatusId":0,"ModDate":"0001-01-01T00:00:00.0000000","ModBy":"00000000000000000000000000000000"}]}