Trendsic Platform Service

<back to all web services

InspectionRequestUpdateRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/inspections/{InspectionUID}/requests/{InspectionRequestID}
<?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 InspectionRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $InspectionRequestID=0,
        /** @var int */
        public int $InspectionID=0,
        /** @var string|null */
        public ?string $Agency=null,
        /** @var string|null */
        public ?string $ContactName=null,
        /** @var string|null */
        public ?string $ContactPhone=null,
        /** @var string|null */
        public ?string $PermitNo=null,
        /** @var DateTime|null */
        public ?DateTime $RequestedDate=null,
        /** @var string|null */
        public ?string $RequestedWindow=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $ConfirmationNo=null,
        /** @var string|null */
        public ?string $Outcome=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['InspectionRequestID'])) $this->InspectionRequestID = $o['InspectionRequestID'];
        if (isset($o['InspectionID'])) $this->InspectionID = $o['InspectionID'];
        if (isset($o['Agency'])) $this->Agency = $o['Agency'];
        if (isset($o['ContactName'])) $this->ContactName = $o['ContactName'];
        if (isset($o['ContactPhone'])) $this->ContactPhone = $o['ContactPhone'];
        if (isset($o['PermitNo'])) $this->PermitNo = $o['PermitNo'];
        if (isset($o['RequestedDate'])) $this->RequestedDate = JsonConverters::from('DateTime', $o['RequestedDate']);
        if (isset($o['RequestedWindow'])) $this->RequestedWindow = $o['RequestedWindow'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['ConfirmationNo'])) $this->ConfirmationNo = $o['ConfirmationNo'];
        if (isset($o['Outcome'])) $this->Outcome = $o['Outcome'];
        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->InspectionRequestID)) $o['InspectionRequestID'] = $this->InspectionRequestID;
        if (isset($this->InspectionID)) $o['InspectionID'] = $this->InspectionID;
        if (isset($this->Agency)) $o['Agency'] = $this->Agency;
        if (isset($this->ContactName)) $o['ContactName'] = $this->ContactName;
        if (isset($this->ContactPhone)) $o['ContactPhone'] = $this->ContactPhone;
        if (isset($this->PermitNo)) $o['PermitNo'] = $this->PermitNo;
        if (isset($this->RequestedDate)) $o['RequestedDate'] = JsonConverters::to('DateTime', $this->RequestedDate);
        if (isset($this->RequestedWindow)) $o['RequestedWindow'] = $this->RequestedWindow;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->ConfirmationNo)) $o['ConfirmationNo'] = $this->ConfirmationNo;
        if (isset($this->Outcome)) $o['Outcome'] = $this->Outcome;
        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 InspectionRequestsResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<InspectionRequest>|null */
        public ?array $Requests=null
    ) {
    }

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

class InspectionRequestUpdateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $InspectionUID='',
        /** @var int */
        public int $InspectionRequestID=0,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $ConfirmationNo=null,
        /** @var string|null */
        public ?string $Outcome=null,
        /** @var DateTime|null */
        public ?DateTime $RequestedDate=null,
        /** @var string|null */
        public ?string $RequestedWindow=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['InspectionUID'])) $this->InspectionUID = $o['InspectionUID'];
        if (isset($o['InspectionRequestID'])) $this->InspectionRequestID = $o['InspectionRequestID'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['ConfirmationNo'])) $this->ConfirmationNo = $o['ConfirmationNo'];
        if (isset($o['Outcome'])) $this->Outcome = $o['Outcome'];
        if (isset($o['RequestedDate'])) $this->RequestedDate = JsonConverters::from('DateTime', $o['RequestedDate']);
        if (isset($o['RequestedWindow'])) $this->RequestedWindow = $o['RequestedWindow'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->InspectionUID)) $o['InspectionUID'] = $this->InspectionUID;
        if (isset($this->InspectionRequestID)) $o['InspectionRequestID'] = $this->InspectionRequestID;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->ConfirmationNo)) $o['ConfirmationNo'] = $this->ConfirmationNo;
        if (isset($this->Outcome)) $o['Outcome'] = $this->Outcome;
        if (isset($this->RequestedDate)) $o['RequestedDate'] = JsonConverters::to('DateTime', $this->RequestedDate);
        if (isset($this->RequestedWindow)) $o['RequestedWindow'] = $this->RequestedWindow;
        return empty($o) ? new class(){} : $o;
    }
}

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

PUT /v1/inspections/{InspectionUID}/requests/{InspectionRequestID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InspectionRequestUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ConfirmationNo>String</ConfirmationNo>
  <InspectionRequestID>0</InspectionRequestID>
  <InspectionUID>00000000-0000-0000-0000-000000000000</InspectionUID>
  <Outcome>String</Outcome>
  <RequestedDate>0001-01-01T00:00:00</RequestedDate>
  <RequestedWindow>String</RequestedWindow>
  <Status>String</Status>
</InspectionRequestUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InspectionRequestsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Requests>
    <InspectionRequest>
      <Agency>String</Agency>
      <ConfirmationNo>String</ConfirmationNo>
      <ContactName>String</ContactName>
      <ContactPhone>String</ContactPhone>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <InspectionID>0</InspectionID>
      <InspectionRequestID>0</InspectionRequestID>
      <Outcome>String</Outcome>
      <PermitNo>String</PermitNo>
      <RequestedDate>0001-01-01T00:00:00</RequestedDate>
      <RequestedWindow>String</RequestedWindow>
      <Status>String</Status>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </InspectionRequest>
  </Requests>
  <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>
</InspectionRequestsResponse>