sfgboxapi

<back to all web services

CompetitorsLookup

The following routes are available for this service:
GET/competitors
<?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};


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

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

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

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

GET /competitors HTTP/1.1 
Host: api.sfgtec.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCompetitorsLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <CompetitorsLookupResponse>
    <CompetitorCropsId>0</CompetitorCropsId>
    <CropsId>0</CropsId>
    <PenaltyPercentage>0</PenaltyPercentage>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <TenantsId>0</TenantsId>
    <ZonesId>0</ZonesId>
  </CompetitorsLookupResponse>
</ArrayOfCompetitorsLookupResponse>