sfgboxapi

<back to all web services

UsersBoxesLookup

Requires Authentication
The following routes are available for this service:
GET/users_boxes
<?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};


// @DataContract
class UsersBoxesLookup implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $appUserId=0,

        // @DataMember(Order=3)
        /** @var int */
        public int $authAppUserId=0,

        // @DataMember(Order=4)
        /** @var DateTime */
        public DateTime $deploymentDate=new DateTime(),

        // @DataMember(Order=5)
        /** @var int */
        public int $numberBoxes=0,

        // @DataMember(Order=6)
        /** @var string|null */
        public ?string $recipientType=null,

        // @DataMember(Order=7)
        /** @var int|null */
        public ?int $foodGardensId=null,

        // @DataMember(Order=8)
        /** @var string|null */
        public ?string $otherDescription=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        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'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        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;
        return empty($o) ? new class(){} : $o;
    }
}

PHP UsersBoxesLookup 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 /users_boxes HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfUsersBoxesLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <UsersBoxesLookupResponse>
    <AppUserId>0</AppUserId>
    <AuthAppUserId>0</AuthAppUserId>
    <DeploymentDate>0001-01-01T00:00:00</DeploymentDate>
    <FoodGardensId>0</FoodGardensId>
    <NumberBoxes>0</NumberBoxes>
    <OtherDescription>String</OtherDescription>
    <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>
  </UsersBoxesLookupResponse>
</ArrayOfUsersBoxesLookupResponse>