sfgboxapi

<back to all web services

VarietiesAdd

Requires Authentication
The following routes are available for this service:
POST/varieties
<?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 VarietiesAddResponse implements JsonSerializable
{
    public function __construct(
        // @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['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->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 VarietiesAdd implements JsonSerializable
{
    public function __construct(
        // @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['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->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 VarietiesAdd DTOs

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

HTTP + JSV

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

POST /varieties HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	tenantsId: 0,
	zonesId: 0,
	cropsId: 0,
	name: String,
	about: String,
	heightsCm: 0,
	needSupport: False,
	needStakes: False,
	needTrellis: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	tenantsId: 0,
	zonesId: 0,
	cropsId: 0,
	name: String,
	about: String,
	heightsCm: 0,
	needSupport: False,
	needStakes: False,
	needTrellis: False,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}