sfgboxapi

CompetitorsEdit

The following routes are available for this service:
PUT	/competitors/{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 CompetitorsEditResponse 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 int */
        public int $competitorCropsId=0,

        // @DataMember(Order=6)
        /** @var float */
        public float $penaltyPercentage=0.0,

        // @DataMember(Order=8)
        /** @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['competitorCropsId'])) $this->competitorCropsId = $o['competitorCropsId'];
        if (isset($o['penaltyPercentage'])) $this->penaltyPercentage = $o['penaltyPercentage'];
        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->competitorCropsId)) $o['competitorCropsId'] = $this->competitorCropsId;
        if (isset($this->penaltyPercentage)) $o['penaltyPercentage'] = $this->penaltyPercentage;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class CompetitorsEdit 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 int */
        public int $competitorCropsId=0,

        // @DataMember(Order=6)
        // @Validate(Validator="NotNull")
        /** @var float */
        public float $penaltyPercentage=0.0
    ) {
    }

    /** @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['competitorCropsId'])) $this->competitorCropsId = $o['competitorCropsId'];
        if (isset($o['penaltyPercentage'])) $this->penaltyPercentage = $o['penaltyPercentage'];
    }
    
    /** @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->competitorCropsId)) $o['competitorCropsId'] = $this->competitorCropsId;
        if (isset($this->penaltyPercentage)) $o['penaltyPercentage'] = $this->penaltyPercentage;
        return empty($o) ? new class(){} : $o;
    }
}

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

PUT /competitors/{Id} HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	tenantsId: 0,
	zonesId: 0,
	cropsId: 0,
	competitorCropsId: 0,
	penaltyPercentage: 0
}

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

{
	id: 0,
	tenantsId: 0,
	zonesId: 0,
	cropsId: 0,
	competitorCropsId: 0,
	penaltyPercentage: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}