sfgboxapi

DistributedBoxesViewLookup

The following routes are available for this service:
GET	/distributed_boxes_view

<?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 DistributedBoxesViewLookup implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var int */
        public int $tenantsId=0,
        /** @var int */
        public int $appUserId=0,
        /** @var int */
        public int $authAppUserId=0,
        /** @var DateTime */
        public DateTime $deploymentDate=new DateTime(),
        /** @var int */
        public int $numberBoxes=0,
        /** @var string|null */
        public ?string $recipientType=null,
        /** @var int */
        public int $foodGardensId=0,
        /** @var string|null */
        public ?string $otherDescription=null,
        /** @var float */
        public float $latitude=0.0,
        /** @var float */
        public float $longitude=0.0,
        /** @var string|null */
        public ?string $phoneNumber=null,
        /** @var string|null */
        public ?string $displayName=null,
        /** @var string|null */
        public ?string $email=null,
        /** @var DateTime */
        public DateTime $applicationDate=new DateTime(),
        /** @var bool|null */
        public ?bool $isZoneMain=null,
        /** @var bool|null */
        public ?bool $isDisabled=null,
        /** @var string|null */
        public ?string $gender=null,
        /** @var string|null */
        public ?string $ethnicGroup=null,
        /** @var int */
        public int $age=0,
        /** @var DateTime */
        public DateTime $approvalDate=new DateTime(),
        /** @var bool|null */
        public ?bool $approved=null,
        /** @var string|null */
        public ?string $authorizedBy=null,
        /** @var string|null */
        public ?string $mediaPath=null,
        /** @var string|null */
        public ?string $name=null,
        /** @var string|null */
        public ?string $description=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['tenantsId'])) $this->tenantsId = $o['tenantsId'];
        if (isset($o['appUserId'])) $this->appUserId = $o['appUserId'];
        if (isset($o['authAppUserId'])) $this->authAppUserId = $o['authAppUserId'];
        if (isset($o['deploymentDate'])) $this->deploymentDate = JsonConverters::from('DateTime', $o['deploymentDate']);
        if (isset($o['numberBoxes'])) $this->numberBoxes = $o['numberBoxes'];
        if (isset($o['recipientType'])) $this->recipientType = $o['recipientType'];
        if (isset($o['foodGardensId'])) $this->foodGardensId = $o['foodGardensId'];
        if (isset($o['otherDescription'])) $this->otherDescription = $o['otherDescription'];
        if (isset($o['latitude'])) $this->latitude = $o['latitude'];
        if (isset($o['longitude'])) $this->longitude = $o['longitude'];
        if (isset($o['phoneNumber'])) $this->phoneNumber = $o['phoneNumber'];
        if (isset($o['displayName'])) $this->displayName = $o['displayName'];
        if (isset($o['email'])) $this->email = $o['email'];
        if (isset($o['applicationDate'])) $this->applicationDate = JsonConverters::from('DateTime', $o['applicationDate']);
        if (isset($o['isZoneMain'])) $this->isZoneMain = $o['isZoneMain'];
        if (isset($o['isDisabled'])) $this->isDisabled = $o['isDisabled'];
        if (isset($o['gender'])) $this->gender = $o['gender'];
        if (isset($o['ethnicGroup'])) $this->ethnicGroup = $o['ethnicGroup'];
        if (isset($o['age'])) $this->age = $o['age'];
        if (isset($o['approvalDate'])) $this->approvalDate = JsonConverters::from('DateTime', $o['approvalDate']);
        if (isset($o['approved'])) $this->approved = $o['approved'];
        if (isset($o['authorizedBy'])) $this->authorizedBy = $o['authorizedBy'];
        if (isset($o['mediaPath'])) $this->mediaPath = $o['mediaPath'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['description'])) $this->description = $o['description'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->tenantsId)) $o['tenantsId'] = $this->tenantsId;
        if (isset($this->appUserId)) $o['appUserId'] = $this->appUserId;
        if (isset($this->authAppUserId)) $o['authAppUserId'] = $this->authAppUserId;
        if (isset($this->deploymentDate)) $o['deploymentDate'] = JsonConverters::to('DateTime', $this->deploymentDate);
        if (isset($this->numberBoxes)) $o['numberBoxes'] = $this->numberBoxes;
        if (isset($this->recipientType)) $o['recipientType'] = $this->recipientType;
        if (isset($this->foodGardensId)) $o['foodGardensId'] = $this->foodGardensId;
        if (isset($this->otherDescription)) $o['otherDescription'] = $this->otherDescription;
        if (isset($this->latitude)) $o['latitude'] = $this->latitude;
        if (isset($this->longitude)) $o['longitude'] = $this->longitude;
        if (isset($this->phoneNumber)) $o['phoneNumber'] = $this->phoneNumber;
        if (isset($this->displayName)) $o['displayName'] = $this->displayName;
        if (isset($this->email)) $o['email'] = $this->email;
        if (isset($this->applicationDate)) $o['applicationDate'] = JsonConverters::to('DateTime', $this->applicationDate);
        if (isset($this->isZoneMain)) $o['isZoneMain'] = $this->isZoneMain;
        if (isset($this->isDisabled)) $o['isDisabled'] = $this->isDisabled;
        if (isset($this->gender)) $o['gender'] = $this->gender;
        if (isset($this->ethnicGroup)) $o['ethnicGroup'] = $this->ethnicGroup;
        if (isset($this->age)) $o['age'] = $this->age;
        if (isset($this->approvalDate)) $o['approvalDate'] = JsonConverters::to('DateTime', $this->approvalDate);
        if (isset($this->approved)) $o['approved'] = $this->approved;
        if (isset($this->authorizedBy)) $o['authorizedBy'] = $this->authorizedBy;
        if (isset($this->mediaPath)) $o['mediaPath'] = $this->mediaPath;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->description)) $o['description'] = $this->description;
        return empty($o) ? new class(){} : $o;
    }
}

PHP DistributedBoxesViewLookup 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 /distributed_boxes_view HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml

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

<ArrayOfDistributedBoxesViewLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <DistributedBoxesViewLookupResponse>
    <Age>0</Age>
    <AppUserId>0</AppUserId>
    <ApplicationDate>0001-01-01T00:00:00</ApplicationDate>
    <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
    <Approved>false</Approved>
    <AuthAppUserId>0</AuthAppUserId>
    <AuthorizedBy>String</AuthorizedBy>
    <Description>String</Description>
    <DisplayName>String</DisplayName>
    <Email>String</Email>
    <EthnicGroup>String</EthnicGroup>
    <FoodGardensId>0</FoodGardensId>
    <Gender>String</Gender>
    <Id>0</Id>
    <IsDisabled>false</IsDisabled>
    <IsZoneMain>false</IsZoneMain>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <MediaPath>String</MediaPath>
    <Name>String</Name>
    <NumberBoxes>0</NumberBoxes>
    <OtherDescription>String</OtherDescription>
    <PhoneNumber>String</PhoneNumber>
    <RecipientType>String</RecipientType>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <TenantsId>0</TenantsId>
    <deploymentDate>0001-01-01T00:00:00</deploymentDate>
  </DistributedBoxesViewLookupResponse>
</ArrayOfDistributedBoxesViewLookupResponse>