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 .csv suffix or ?format=csv

HTTP + CSV

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

GET /competitors HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'IEnumerable`1' using the custom 'csv' filter}Cannot dynamically create an instance of type 'System.Collections.Generic.IEnumerable`1[sfgboxapi.ServiceModel.CompetitorsLookupResponse]'. Reason: Cannot create an instance of an interface.