sfgboxapi

<back to all web services

GrowplansBoxesEdit

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

        // @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['id'])) $this->id = $o['id'];
        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->id)) $o['id'] = $this->id;
        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 GrowplansBoxesEdit 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 $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['id'])) $this->id = $o['id'];
        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->id)) $o['id'] = $this->id;
        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 GrowplansBoxesEdit 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 /growplans_boxes/{Id} HTTP/1.1 
Host: api.sfgtec.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GrowplansBoxesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <GrowplansUsersId>0</GrowplansUsersId>
  <Name>String</Name>
  <XAxis>0</XAxis>
  <YAxis>0</YAxis>
  <GrowplansOutcomesId>0</GrowplansOutcomesId>
  <Months>0</Months>
  <StartDate>0001-01-01T00:00:00</StartDate>
</GrowplansBoxesEdit>

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

<GrowplansBoxesEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <GrowplansOutcomesId>0</GrowplansOutcomesId>
  <GrowplansUsersId>0</GrowplansUsersId>
  <Id>0</Id>
  <Months>0</Months>
  <Name>String</Name>
  <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>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <XAxis>0</XAxis>
  <YAxis>0</YAxis>
</GrowplansBoxesEditResponse>