sfgboxapi

<back to all web services

GrowersListLookup

Requires Authentication
The following routes are available for this service:
GET/growerslist
<?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 Paging implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $pageNumber=0,
        /** @var int */
        public int $pageSize=0
    ) {
    }

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

class GrowersListLookup implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var int */
        public int $tenantsId=0,
        /** @var string|null */
        public ?string $displayName=null,
        /** @var string|null */
        public ?string $firstName=null,
        /** @var string|null */
        public ?string $lastName=null,
        /** @var string|null */
        public ?string $email=null,
        /** @var string|null */
        public ?string $phoneNumber=null,
        /** @var int */
        public int $appUserId=0,
        /** @var bool|null */
        public ?bool $approved=null,
        /** @var DateTime */
        public DateTime $approvalDate=new DateTime(),
        /** @var DateTime */
        public DateTime $applicationDate=new DateTime(),
        /** @var string|null */
        public ?string $identificationNumber=null,
        /** @var string|null */
        public ?string $passportNumber=null,
        /** @var string|null */
        public ?string $address=null,
        /** @var string|null */
        public ?string $ethnicGroup=null,
        /** @var string|null */
        public ?string $gender=null,
        /** @var bool|null */
        public ?bool $isDisabled=null,
        /** @var float */
        public float $latitude=0.0,
        /** @var float */
        public float $longitude=0.0,
        /** @var string|null */
        public ?string $documentUrl=null,
        /** @var bool|null */
        public ?bool $isZoneMain=null,
        /** @var Paging|null */
        public ?Paging $paging=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['displayName'])) $this->displayName = $o['displayName'];
        if (isset($o['firstName'])) $this->firstName = $o['firstName'];
        if (isset($o['lastName'])) $this->lastName = $o['lastName'];
        if (isset($o['email'])) $this->email = $o['email'];
        if (isset($o['phoneNumber'])) $this->phoneNumber = $o['phoneNumber'];
        if (isset($o['appUserId'])) $this->appUserId = $o['appUserId'];
        if (isset($o['approved'])) $this->approved = $o['approved'];
        if (isset($o['approvalDate'])) $this->approvalDate = JsonConverters::from('DateTime', $o['approvalDate']);
        if (isset($o['applicationDate'])) $this->applicationDate = JsonConverters::from('DateTime', $o['applicationDate']);
        if (isset($o['identificationNumber'])) $this->identificationNumber = $o['identificationNumber'];
        if (isset($o['passportNumber'])) $this->passportNumber = $o['passportNumber'];
        if (isset($o['address'])) $this->address = $o['address'];
        if (isset($o['ethnicGroup'])) $this->ethnicGroup = $o['ethnicGroup'];
        if (isset($o['gender'])) $this->gender = $o['gender'];
        if (isset($o['isDisabled'])) $this->isDisabled = $o['isDisabled'];
        if (isset($o['latitude'])) $this->latitude = $o['latitude'];
        if (isset($o['longitude'])) $this->longitude = $o['longitude'];
        if (isset($o['documentUrl'])) $this->documentUrl = $o['documentUrl'];
        if (isset($o['isZoneMain'])) $this->isZoneMain = $o['isZoneMain'];
        if (isset($o['paging'])) $this->paging = JsonConverters::from('Paging', $o['paging']);
    }
    
    /** @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->displayName)) $o['displayName'] = $this->displayName;
        if (isset($this->firstName)) $o['firstName'] = $this->firstName;
        if (isset($this->lastName)) $o['lastName'] = $this->lastName;
        if (isset($this->email)) $o['email'] = $this->email;
        if (isset($this->phoneNumber)) $o['phoneNumber'] = $this->phoneNumber;
        if (isset($this->appUserId)) $o['appUserId'] = $this->appUserId;
        if (isset($this->approved)) $o['approved'] = $this->approved;
        if (isset($this->approvalDate)) $o['approvalDate'] = JsonConverters::to('DateTime', $this->approvalDate);
        if (isset($this->applicationDate)) $o['applicationDate'] = JsonConverters::to('DateTime', $this->applicationDate);
        if (isset($this->identificationNumber)) $o['identificationNumber'] = $this->identificationNumber;
        if (isset($this->passportNumber)) $o['passportNumber'] = $this->passportNumber;
        if (isset($this->address)) $o['address'] = $this->address;
        if (isset($this->ethnicGroup)) $o['ethnicGroup'] = $this->ethnicGroup;
        if (isset($this->gender)) $o['gender'] = $this->gender;
        if (isset($this->isDisabled)) $o['isDisabled'] = $this->isDisabled;
        if (isset($this->latitude)) $o['latitude'] = $this->latitude;
        if (isset($this->longitude)) $o['longitude'] = $this->longitude;
        if (isset($this->documentUrl)) $o['documentUrl'] = $this->documentUrl;
        if (isset($this->isZoneMain)) $o['isZoneMain'] = $this->isZoneMain;
        if (isset($this->paging)) $o['paging'] = JsonConverters::to('Paging', $this->paging);
        return empty($o) ? new class(){} : $o;
    }
}

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

<ArrayOfGrowersListLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <GrowersListLookupResponse>
    <Address>String</Address>
    <AppUserId>0</AppUserId>
    <ApplicationDate>0001-01-01T00:00:00</ApplicationDate>
    <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
    <Approved>false</Approved>
    <DisplayName>String</DisplayName>
    <DocumentUrl>String</DocumentUrl>
    <Email>String</Email>
    <EthnicGroup>String</EthnicGroup>
    <FirstName>String</FirstName>
    <Gender>String</Gender>
    <Id>0</Id>
    <IdentificationNumber>String</IdentificationNumber>
    <IsDisabled>false</IsDisabled>
    <IsZoneMain>false</IsZoneMain>
    <LastName>String</LastName>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <PassportNumber>String</PassportNumber>
    <PhoneNumber>String</PhoneNumber>
    <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>
  </GrowersListLookupResponse>
</ArrayOfGrowersListLookupResponse>