sfgboxapi

<back to all web services

CropsProductsHarvestsLookup

The following routes are available for this service:
GET/cropsproductsharvests
<?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 CropsProductsHarvestsLookup implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var int */
        public int $tenantsId=0,
        /** @var string|null */
        public ?string $cropsName=null,
        /** @var int */
        public int $varietiesId=0,
        /** @var string|null */
        public ?string $varietiesName=null,
        /** @var string|null */
        public ?string $productsName=null,
        /** @var string|null */
        public ?string $harvestDescription=null,
        /** @var int */
        public int $quarters=0,
        /** @var int */
        public int $qtyG=0,
        /** @var bool|null */
        public ?bool $final=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['cropsName'])) $this->cropsName = $o['cropsName'];
        if (isset($o['varietiesId'])) $this->varietiesId = $o['varietiesId'];
        if (isset($o['varietiesName'])) $this->varietiesName = $o['varietiesName'];
        if (isset($o['productsName'])) $this->productsName = $o['productsName'];
        if (isset($o['harvestDescription'])) $this->harvestDescription = $o['harvestDescription'];
        if (isset($o['quarters'])) $this->quarters = $o['quarters'];
        if (isset($o['qtyG'])) $this->qtyG = $o['qtyG'];
        if (isset($o['final'])) $this->final = $o['final'];
        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->cropsName)) $o['cropsName'] = $this->cropsName;
        if (isset($this->varietiesId)) $o['varietiesId'] = $this->varietiesId;
        if (isset($this->varietiesName)) $o['varietiesName'] = $this->varietiesName;
        if (isset($this->productsName)) $o['productsName'] = $this->productsName;
        if (isset($this->harvestDescription)) $o['harvestDescription'] = $this->harvestDescription;
        if (isset($this->quarters)) $o['quarters'] = $this->quarters;
        if (isset($this->qtyG)) $o['qtyG'] = $this->qtyG;
        if (isset($this->final)) $o['final'] = $this->final;
        if (isset($this->paging)) $o['paging'] = JsonConverters::to('Paging', $this->paging);
        return empty($o) ? new class(){} : $o;
    }
}

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

<ArrayOfCropsProductsHarvestsLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <CropsProductsHarvestsLookupResponse>
    <CropsName>String</CropsName>
    <Final>false</Final>
    <HarvestDescription>String</HarvestDescription>
    <Id>0</Id>
    <ProductsName>String</ProductsName>
    <QtyG>0</QtyG>
    <Quarters>0</Quarters>
    <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>
    <VarietiesId>0</VarietiesId>
    <VarietiesName>String</VarietiesName>
  </CropsProductsHarvestsLookupResponse>
</ArrayOfCropsProductsHarvestsLookupResponse>