BokaMera.API.Host

<back to all web services

CodeLockSiedleSettingQuery

<?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};


enum SiedleIntegrationType : int
{
    case LocalApi = 1;
    case CloudBasedApi = 2;
}

class CodeLockSiedleSettingResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $CompanyId='',
        /** @description The api endpoint of the code lock */
        // @ApiMember(DataType="string", Description="The api endpoint of the code lock")
        /** @var string|null */
        public ?string $ApiEndpoint=null,

        /** @description The api port for the code lock. */
        // @ApiMember(DataType="string", Description="The api port for the code lock.")
        /** @var int|null */
        public ?int $ApiPort=null,

        /** @description The device id to the code lock. */
        // @ApiMember(DataType="string", Description="The device id to the code lock.")
        /** @var string|null */
        public ?string $DeviceId=null,

        /** @description The username to logon to the code lock. */
        // @ApiMember(DataType="string", Description="The username to logon to the code lock.")
        /** @var string|null */
        public ?string $Username=null,

        /** @description The password to logon to the code lock. */
        // @ApiMember(DataType="string", Description="The password to logon to the code lock.")
        /** @var string|null */
        public ?string $Password=null,

        /** @description The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api */
        // @ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api")
        /** @var SiedleIntegrationType|null */
        public ?SiedleIntegrationType $IntegrationType=null,

        /** @description When settings was created */
        // @ApiMember(DataType="datetime", Description="When settings was created")
        /** @var DateTime */
        public DateTime $Created=new DateTime(),

        /** @description When settings was updated */
        // @ApiMember(DataType="datetime", Description="When settings was updated")
        /** @var DateTime */
        public DateTime $Updated=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['ApiEndpoint'])) $this->ApiEndpoint = $o['ApiEndpoint'];
        if (isset($o['ApiPort'])) $this->ApiPort = $o['ApiPort'];
        if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
        if (isset($o['Username'])) $this->Username = $o['Username'];
        if (isset($o['Password'])) $this->Password = $o['Password'];
        if (isset($o['IntegrationType'])) $this->IntegrationType = JsonConverters::from('SiedleIntegrationType', $o['IntegrationType']);
        if (isset($o['Created'])) $this->Created = JsonConverters::from('DateTime', $o['Created']);
        if (isset($o['Updated'])) $this->Updated = JsonConverters::from('DateTime', $o['Updated']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->ApiEndpoint)) $o['ApiEndpoint'] = $this->ApiEndpoint;
        if (isset($this->ApiPort)) $o['ApiPort'] = $this->ApiPort;
        if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
        if (isset($this->Username)) $o['Username'] = $this->Username;
        if (isset($this->Password)) $o['Password'] = $this->Password;
        if (isset($this->IntegrationType)) $o['IntegrationType'] = JsonConverters::to('SiedleIntegrationType', $this->IntegrationType);
        if (isset($this->Created)) $o['Created'] = JsonConverters::to('DateTime', $this->Created);
        if (isset($this->Updated)) $o['Updated'] = JsonConverters::to('DateTime', $this->Updated);
        return empty($o) ? new class(){} : $o;
    }
}

// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)
class CodeLockSiedleSettingQuery implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description The company id, if empty will use the company id for the user you are logged in with. */
        // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        /** @var string|null */
        public ?string $CompanyId=null
    ) {
    }

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

PHP CodeLockSiedleSettingQuery DTOs

GET /codelock/siedle/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

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

{
	ApiEndpoint: String,
	ApiPort: 0,
	DeviceId: String,
	Username: String,
	Password: String,
	IntegrationType: LocalApi
}