Six4Win.WebApi

<back to all web services

ConfigureLocalCodePot

Requires Authentication
The following routes are available for this service:
POST/cmd/configure/lcp
<?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 ThresholdInterval implements JsonSerializable
{
    public function __construct(
        /** @var float */
        public float $start=0.0,
        /** @var float */
        public float $end=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['start'])) $this->start = $o['start'];
        if (isset($o['end'])) $this->end = $o['end'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->start)) $o['start'] = $this->start;
        if (isset($this->end)) $o['end'] = $this->end;
        return empty($o) ? new class(){} : $o;
    }
}

class LCPConfiguration implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $isActive=null,
        /** @var ThresholdInterval|null */
        public ?ThresholdInterval $interval=null,
        /** @var float */
        public float $pct=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['isActive'])) $this->isActive = $o['isActive'];
        if (isset($o['interval'])) $this->interval = JsonConverters::from('ThresholdInterval', $o['interval']);
        if (isset($o['pct'])) $this->pct = $o['pct'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->isActive)) $o['isActive'] = $this->isActive;
        if (isset($this->interval)) $o['interval'] = JsonConverters::to('ThresholdInterval', $this->interval);
        if (isset($this->pct)) $o['pct'] = $this->pct;
        return empty($o) ? new class(){} : $o;
    }
}

class ConfigureLocalCodePot implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $id=null,
        /** @var string|null */
        public ?string $scopeId=null,
        /** @var string|null */
        public ?string $scopeName=null,
        /** @var LCPConfiguration|null */
        public ?LCPConfiguration $configuration=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['scopeId'])) $this->scopeId = $o['scopeId'];
        if (isset($o['scopeName'])) $this->scopeName = $o['scopeName'];
        if (isset($o['configuration'])) $this->configuration = JsonConverters::from('LCPConfiguration', $o['configuration']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->scopeId)) $o['scopeId'] = $this->scopeId;
        if (isset($this->scopeName)) $o['scopeName'] = $this->scopeName;
        if (isset($this->configuration)) $o['configuration'] = JsonConverters::to('LCPConfiguration', $this->configuration);
        return empty($o) ? new class(){} : $o;
    }
}

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

POST /cmd/configure/lcp HTTP/1.1 
Host: s4w2.api.bettor.cc 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	scopeId: String,
	scopeName: String,
	configuration: 
	{
		isActive: False,
		interval: 
		{
			start: 0,
			end: 0
		},
		pct: 0
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}