sfgboxapi

<back to all web services

UsersDetailsAutoQueryLookup

<?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 QueryBase implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int|null */
        public ?int $skip=null,

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

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

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

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

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

        // @DataMember(Order=7)
        /** @var array<string,string>|null */
        public ?array $meta=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['skip'])) $this->skip = $o['skip'];
        if (isset($o['take'])) $this->take = $o['take'];
        if (isset($o['orderBy'])) $this->orderBy = $o['orderBy'];
        if (isset($o['orderByDesc'])) $this->orderByDesc = $o['orderByDesc'];
        if (isset($o['include'])) $this->include = $o['include'];
        if (isset($o['fields'])) $this->fields = $o['fields'];
        if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->skip)) $o['skip'] = $this->skip;
        if (isset($this->take)) $o['take'] = $this->take;
        if (isset($this->orderBy)) $o['orderBy'] = $this->orderBy;
        if (isset($this->orderByDesc)) $o['orderByDesc'] = $this->orderByDesc;
        if (isset($this->include)) $o['include'] = $this->include;
        if (isset($this->fields)) $o['fields'] = $this->fields;
        if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template T
 */
class QueryDb extends QueryBase implements JsonSerializable
{
    public array $genericArgs = [];
    public static function create(array $genericArgs=[]): QueryDb {
        $to = new QueryDb();
        $to->genericArgs = $genericArgs;
        return $to;
    }

    /**
     * @param int|null $skip
     * @param int|null $take
     * @param string|null $orderBy
     * @param string|null $orderByDesc
     * @param string|null $include
     * @param string|null $fields
     * @param array<string,string>|null $meta
     */
    public function __construct(
        mixed $skip=null,
        mixed $take=null,
        mixed $orderBy=null,
        mixed $orderByDesc=null,
        mixed $include=null,
        mixed $fields=null,
        mixed $meta=null
    ) {
        parent::__construct($skip,$take,$orderBy,$orderByDesc,$include,$fields,$meta);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

class UsersDetails implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @Required()
        /** @var int */
        public int $id=0,

        // @DataMember(Order=2)
        // @Required()
        // @References("typeof(sfgboxapi.ServiceModel.Types.AppUser)")
        /** @var int */
        public int $appUserId=0,

        // @DataMember(Order=3)
        /** @var bool|null */
        public ?bool $approved=null,

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

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

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

        // @DataMember(Order=7)
        /** @var float */
        public float $latitude=0.0,

        // @DataMember(Order=8)
        /** @var float */
        public float $longitude=0.0,

        // @DataMember(Order=9)
        /** @var int */
        public int $age=0,

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

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

        // @DataMember(Order=12)
        /** @var bool|null */
        public ?bool $isDisabled=null,

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

        // @DataMember(Order=14)
        /** @var DateTime */
        public DateTime $applicationDate=new DateTime(),

        // @DataMember(Order=15)
        /** @var DateTime */
        public DateTime $approvalDate=new DateTime(),

        // @DataMember(Order=16)
        /** @var bool|null */
        public ?bool $isZoneMain=null,

        // @DataMember(Order=16)
        /** @var string */
        public string $publicAccessGuid=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['appUserId'])) $this->appUserId = $o['appUserId'];
        if (isset($o['approved'])) $this->approved = $o['approved'];
        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['latitude'])) $this->latitude = $o['latitude'];
        if (isset($o['longitude'])) $this->longitude = $o['longitude'];
        if (isset($o['age'])) $this->age = $o['age'];
        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['documentUrl'])) $this->documentUrl = $o['documentUrl'];
        if (isset($o['applicationDate'])) $this->applicationDate = JsonConverters::from('DateTime', $o['applicationDate']);
        if (isset($o['approvalDate'])) $this->approvalDate = JsonConverters::from('DateTime', $o['approvalDate']);
        if (isset($o['isZoneMain'])) $this->isZoneMain = $o['isZoneMain'];
        if (isset($o['publicAccessGuid'])) $this->publicAccessGuid = $o['publicAccessGuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->appUserId)) $o['appUserId'] = $this->appUserId;
        if (isset($this->approved)) $o['approved'] = $this->approved;
        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->latitude)) $o['latitude'] = $this->latitude;
        if (isset($this->longitude)) $o['longitude'] = $this->longitude;
        if (isset($this->age)) $o['age'] = $this->age;
        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->documentUrl)) $o['documentUrl'] = $this->documentUrl;
        if (isset($this->applicationDate)) $o['applicationDate'] = JsonConverters::to('DateTime', $this->applicationDate);
        if (isset($this->approvalDate)) $o['approvalDate'] = JsonConverters::to('DateTime', $this->approvalDate);
        if (isset($this->isZoneMain)) $o['isZoneMain'] = $this->isZoneMain;
        if (isset($this->publicAccessGuid)) $o['publicAccessGuid'] = $this->publicAccessGuid;
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template QueryDb of UsersDetails
 */
class UsersDetailsAutoQueryLookup extends QueryDb implements JsonSerializable
{
    /**
     * @param int|null $skip
     * @param int|null $take
     * @param string|null $orderBy
     * @param string|null $orderByDesc
     * @param string|null $include
     * @param string|null $fields
     * @param array<string,string>|null $meta
     */
    public function __construct(
        ?int $skip=null,
        ?int $take=null,
        ?string $orderBy=null,
        ?string $orderByDesc=null,
        ?string $include=null,
        ?string $fields=null,
        ?array $meta=null
    ) {
        parent::__construct($skip,$take,$orderBy,$orderByDesc,$include,$fields,$meta);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

class Tenants implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @Required()
        /** @var int */
        public int $id=0,

        // @DataMember(Order=2)
        // @Required()
        // @References("typeof(sfgboxapi.ServiceModel.Types.Zones)")
        /** @var int */
        public int $mainZonesId=0,

        // @DataMember(Order=3)
        /** @var bool|null */
        public ?bool $isPublic=null
    ) {
    }

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

// @DataContract
/**
 * @template Tenants
 */
class QueryResponse implements JsonSerializable
{
    public array $genericArgs = [];
    public static function create(array $genericArgs=[]): QueryResponse {
        $to = new QueryResponse();
        $to->genericArgs = $genericArgs;
        return $to;
    }

    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public mixed $offset=0,

        // @DataMember(Order=2)
        /** @var int */
        public mixed $total=0,

        // @DataMember(Order=3)
        /** @var array<Tenants>|null */
        public mixed $results=null,

        // @DataMember(Order=4)
        /** @var array<string,string>|null */
        public mixed $meta=null,

        // @DataMember(Order=5)
        /** @var ResponseStatus|null */
        public mixed $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['offset'])) $this->offset = $o['offset'];
        if (isset($o['total'])) $this->total = $o['total'];
        if (isset($o['results'])) $this->results = JsonConverters::fromArray($this->genericArgs[0], $o['results']);
        if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->offset)) $o['offset'] = $this->offset;
        if (isset($this->total)) $o['total'] = $this->total;
        if (isset($this->results)) $o['results'] = JsonConverters::toArray($this->genericArgs[0], $this->results);
        if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

PHP UsersDetailsAutoQueryLookup DTOs

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

HTTP + CSV

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

POST /csv/reply/UsersDetailsAutoQueryLookup HTTP/1.1 
Host: api-stage.smartfarmertech.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"appUserId":0,"approved":false,"identificationNumber":"String","passportNumber":"String","address":"String","latitude":0,"longitude":0,"age":0,"ethnicGroup":"String","gender":"String","isDisabled":false,"documentUrl":"String","applicationDate":"\/Date(-62135596800000-0000)\/","approvalDate":"\/Date(-62135596800000-0000)\/","isZoneMain":false,"publicAccessGuid":"00000000000000000000000000000000"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}