Trendsic Platform Service

<back to all web services

AgreementVisitCompleteRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/serviceagreement/visit/{AgreementJobID}/complete
<?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 AgreementVisit implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgreementJobID=0,
        /** @var int */
        public int $AgreementID=0,
        /** @var int */
        public int $JobID=0,
        /** @var DateTime|null */
        public ?DateTime $OccurrenceDate=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var DateTime|null */
        public ?DateTime $CompletedAt=null,
        /** @var DateTime|null */
        public ?DateTime $CancelledAt=null,
        /** @var string|null */
        public ?string $CancelReason=null,
        /** @var DateTime|null */
        public ?DateTime $ShiftedToDate=null,
        /** @var int|null */
        public ?int $ActualDurationMinutes=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AgreementJobID'])) $this->AgreementJobID = $o['AgreementJobID'];
        if (isset($o['AgreementID'])) $this->AgreementID = $o['AgreementID'];
        if (isset($o['JobID'])) $this->JobID = $o['JobID'];
        if (isset($o['OccurrenceDate'])) $this->OccurrenceDate = JsonConverters::from('DateTime', $o['OccurrenceDate']);
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['CompletedAt'])) $this->CompletedAt = JsonConverters::from('DateTime', $o['CompletedAt']);
        if (isset($o['CancelledAt'])) $this->CancelledAt = JsonConverters::from('DateTime', $o['CancelledAt']);
        if (isset($o['CancelReason'])) $this->CancelReason = $o['CancelReason'];
        if (isset($o['ShiftedToDate'])) $this->ShiftedToDate = JsonConverters::from('DateTime', $o['ShiftedToDate']);
        if (isset($o['ActualDurationMinutes'])) $this->ActualDurationMinutes = $o['ActualDurationMinutes'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AgreementJobID)) $o['AgreementJobID'] = $this->AgreementJobID;
        if (isset($this->AgreementID)) $o['AgreementID'] = $this->AgreementID;
        if (isset($this->JobID)) $o['JobID'] = $this->JobID;
        if (isset($this->OccurrenceDate)) $o['OccurrenceDate'] = JsonConverters::to('DateTime', $this->OccurrenceDate);
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->CompletedAt)) $o['CompletedAt'] = JsonConverters::to('DateTime', $this->CompletedAt);
        if (isset($this->CancelledAt)) $o['CancelledAt'] = JsonConverters::to('DateTime', $this->CancelledAt);
        if (isset($this->CancelReason)) $o['CancelReason'] = $this->CancelReason;
        if (isset($this->ShiftedToDate)) $o['ShiftedToDate'] = JsonConverters::to('DateTime', $this->ShiftedToDate);
        if (isset($this->ActualDurationMinutes)) $o['ActualDurationMinutes'] = $this->ActualDurationMinutes;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

PHP AgreementVisitCompleteRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/serviceagreement/visit/{AgreementJobID}/complete HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AgreementJobID":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Visits":[{"AgreementJobID":0,"AgreementID":0,"JobID":0,"OccurrenceDate":"0001-01-01T00:00:00.0000000","Status":"String","CompletedAt":"0001-01-01T00:00:00.0000000","CancelledAt":"0001-01-01T00:00:00.0000000","CancelReason":"String","ShiftedToDate":"0001-01-01T00:00:00.0000000","ActualDurationMinutes":0}]}