BokaMera.API.Host

CodeLockRcoM5SettingQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read

The following routes are available for this service:
GET	/codelock/rcom5/settings	Get code lock api settings for the currently logged in user	Get code lock api settings for the currently logged in user.

<?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 CodeLockRcoM5SettingResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $CompanyId='',
        /** @description Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/). */
        // @ApiMember(DataType="string", Description="Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).")
        /** @var string */
        public string $ApiEndpoint='',

        /** @description Server id from rcoservers.config of the M5AdminAPI installation. */
        // @ApiMember(DataType="int", Description="Server id from rcoservers.config of the M5AdminAPI installation.")
        /** @var int */
        public int $ServerId=0,

        /** @description System name exactly as in R-CARD M5 Arbetsstation. */
        // @ApiMember(DataType="string", Description="System name exactly as in R-CARD M5 Arbetsstation.")
        /** @var string */
        public string $SystemName='',

        /** @description The API operator username to logon to the RCO M5 system. */
        // @ApiMember(DataType="string", Description="The API operator username to logon to the RCO M5 system.")
        /** @var string */
        public string $Username='',

        /** @description The API operator password to logon to the RCO M5 system. */
        // @ApiMember(DataType="string", Description="The API operator password to logon to the RCO M5 system.")
        /** @var string */
        public string $Password='',

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

        /** @description When settings were updated */
        // @ApiMember(DataType="datetime", Description="When settings were 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['ServerId'])) $this->ServerId = $o['ServerId'];
        if (isset($o['SystemName'])) $this->SystemName = $o['SystemName'];
        if (isset($o['Username'])) $this->Username = $o['Username'];
        if (isset($o['Password'])) $this->Password = $o['Password'];
        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->ServerId)) $o['ServerId'] = $this->ServerId;
        if (isset($this->SystemName)) $o['SystemName'] = $this->SystemName;
        if (isset($this->Username)) $o['Username'] = $this->Username;
        if (isset($this->Password)) $o['Password'] = $this->Password;
        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 CodeLockRcoM5SettingQuery 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 CodeLockRcoM5SettingQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

GET /codelock/rcom5/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl

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

{"ApiEndpoint":"String","ServerId":0,"SystemName":"String","Username":"String","Password":"String"}