sfgboxapi

<back to all web services

GrowplansBoxesAdd

Requires Authentication
The following routes are available for this service:
POST/growplans_boxes
<?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 GrowplansBoxesAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $growplansUsersId=0,

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

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

        // @DataMember(Order=5)
        /** @var int */
        public int $yAxis=0,

        // @DataMember(Order=6)
        /** @var int */
        public int $growplansOutcomesId=0,

        // @DataMember(Order=7)
        /** @var int */
        public int $months=0,

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['growplansUsersId'])) $this->growplansUsersId = $o['growplansUsersId'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['xAxis'])) $this->xAxis = $o['xAxis'];
        if (isset($o['yAxis'])) $this->yAxis = $o['yAxis'];
        if (isset($o['growplansOutcomesId'])) $this->growplansOutcomesId = $o['growplansOutcomesId'];
        if (isset($o['months'])) $this->months = $o['months'];
        if (isset($o['startDate'])) $this->startDate = JsonConverters::from('DateTime', $o['startDate']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->growplansUsersId)) $o['growplansUsersId'] = $this->growplansUsersId;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->xAxis)) $o['xAxis'] = $this->xAxis;
        if (isset($this->yAxis)) $o['yAxis'] = $this->yAxis;
        if (isset($this->growplansOutcomesId)) $o['growplansOutcomesId'] = $this->growplansOutcomesId;
        if (isset($this->months)) $o['months'] = $this->months;
        if (isset($this->startDate)) $o['startDate'] = JsonConverters::to('DateTime', $this->startDate);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

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

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

        // @DataMember(Order=8)
        /** @var DateTime|null */
        public ?DateTime $startDate=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['growplansUsersId'])) $this->growplansUsersId = $o['growplansUsersId'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['xAxis'])) $this->xAxis = $o['xAxis'];
        if (isset($o['yAxis'])) $this->yAxis = $o['yAxis'];
        if (isset($o['growplansOutcomesId'])) $this->growplansOutcomesId = $o['growplansOutcomesId'];
        if (isset($o['months'])) $this->months = $o['months'];
        if (isset($o['startDate'])) $this->startDate = JsonConverters::from('DateTime', $o['startDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->growplansUsersId)) $o['growplansUsersId'] = $this->growplansUsersId;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->xAxis)) $o['xAxis'] = $this->xAxis;
        if (isset($this->yAxis)) $o['yAxis'] = $this->yAxis;
        if (isset($this->growplansOutcomesId)) $o['growplansOutcomesId'] = $this->growplansOutcomesId;
        if (isset($this->months)) $o['months'] = $this->months;
        if (isset($this->startDate)) $o['startDate'] = JsonConverters::to('DateTime', $this->startDate);
        return empty($o) ? new class(){} : $o;
    }
}

PHP GrowplansBoxesAdd DTOs

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

HTTP + OTHER

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

POST /growplans_boxes HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"growplansUsersId":0,"name":"String","xAxis":0,"yAxis":0,"growplansOutcomesId":0,"months":0,"startDate":"\/Date(-62135596800000-0000)\/"}

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

{"growplansUsersId":0,"name":"String","xAxis":0,"yAxis":0,"growplansOutcomesId":0,"months":0,"startDate":"\/Date(-62135596800000-0000)\/","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}