sfgboxapi

<back to all web services

VarietiesEdit

Requires Authentication
The following routes are available for this service:
PUT/varieties/{Id}
<?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 VarietiesEditResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public int $id=0,

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

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

        // @DataMember(Order=4)
        /** @var int */
        public int $cropsId=0,

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

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

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

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

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

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

        // @DataMember(Order=12)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=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['zonesId'])) $this->zonesId = $o['zonesId'];
        if (isset($o['cropsId'])) $this->cropsId = $o['cropsId'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['about'])) $this->about = $o['about'];
        if (isset($o['heightsCm'])) $this->heightsCm = $o['heightsCm'];
        if (isset($o['needSupport'])) $this->needSupport = $o['needSupport'];
        if (isset($o['needStakes'])) $this->needStakes = $o['needStakes'];
        if (isset($o['needTrellis'])) $this->needTrellis = $o['needTrellis'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @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->zonesId)) $o['zonesId'] = $this->zonesId;
        if (isset($this->cropsId)) $o['cropsId'] = $this->cropsId;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->about)) $o['about'] = $this->about;
        if (isset($this->heightsCm)) $o['heightsCm'] = $this->heightsCm;
        if (isset($this->needSupport)) $o['needSupport'] = $this->needSupport;
        if (isset($this->needStakes)) $o['needStakes'] = $this->needStakes;
        if (isset($this->needTrellis)) $o['needTrellis'] = $this->needTrellis;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class VarietiesEdit implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $id=0,

        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $tenantsId=0,

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $zonesId=0,

        // @DataMember(Order=4)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $cropsId=0,

        // @DataMember(Order=5)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $name='',

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

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

        // @DataMember(Order=8)
        // @Validate(Validator="NotNull")
        /** @var bool|null */
        public ?bool $needSupport=null,

        // @DataMember(Order=9)
        // @Validate(Validator="NotNull")
        /** @var bool|null */
        public ?bool $needStakes=null,

        // @DataMember(Order=10)
        // @Validate(Validator="NotNull")
        /** @var bool|null */
        public ?bool $needTrellis=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['zonesId'])) $this->zonesId = $o['zonesId'];
        if (isset($o['cropsId'])) $this->cropsId = $o['cropsId'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['about'])) $this->about = $o['about'];
        if (isset($o['heightsCm'])) $this->heightsCm = $o['heightsCm'];
        if (isset($o['needSupport'])) $this->needSupport = $o['needSupport'];
        if (isset($o['needStakes'])) $this->needStakes = $o['needStakes'];
        if (isset($o['needTrellis'])) $this->needTrellis = $o['needTrellis'];
    }
    
    /** @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->zonesId)) $o['zonesId'] = $this->zonesId;
        if (isset($this->cropsId)) $o['cropsId'] = $this->cropsId;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->about)) $o['about'] = $this->about;
        if (isset($this->heightsCm)) $o['heightsCm'] = $this->heightsCm;
        if (isset($this->needSupport)) $o['needSupport'] = $this->needSupport;
        if (isset($this->needStakes)) $o['needStakes'] = $this->needStakes;
        if (isset($this->needTrellis)) $o['needTrellis'] = $this->needTrellis;
        return empty($o) ? new class(){} : $o;
    }
}

PHP VarietiesEdit 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.

PUT /varieties/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<VarietiesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <ZonesId>0</ZonesId>
  <CropsId>0</CropsId>
  <Name>String</Name>
  <About>String</About>
  <HeightsCm>0</HeightsCm>
  <NeedSupport>false</NeedSupport>
  <NeedStakes>false</NeedStakes>
  <NeedTrellis>false</NeedTrellis>
</VarietiesEdit>

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

<VarietiesEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <About>String</About>
  <CropsId>0</CropsId>
  <HeightsCm>0</HeightsCm>
  <Id>0</Id>
  <Name>String</Name>
  <NeedStakes>false</NeedStakes>
  <NeedSupport>false</NeedSupport>
  <NeedTrellis>false</NeedTrellis>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <TenantsId>0</TenantsId>
  <ZonesId>0</ZonesId>
</VarietiesEditResponse>