BokaMera.API.Host

<back to all web services

CodeLockVanderbiltSettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/vanderbilt/settingsGet code lock api settings for the currently logged in userGet 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 CodeLockVanderbiltSettingResponse 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 */
        public int $ApiPort=0,

        /** @description The default identifier for the code lock. */
        // @ApiMember(DataType="string", Description="The default identifier for the code lock.")
        /** @var string|null */
        public ?string $Identifier=null,

        /** @description The default facility id to be used when no set on the resource. */
        // @ApiMember(DataType="string", Description="The default facility id to be used when no set on the resource.")
        /** @var int|null */
        public ?int $DefaultFacilityId=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['Identifier'])) $this->Identifier = $o['Identifier'];
        if (isset($o['DefaultFacilityId'])) $this->DefaultFacilityId = $o['DefaultFacilityId'];
        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->Identifier)) $o['Identifier'] = $this->Identifier;
        if (isset($this->DefaultFacilityId)) $o['DefaultFacilityId'] = $this->DefaultFacilityId;
        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 CodeLockVanderbiltSettingQuery 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 CodeLockVanderbiltSettingQuery DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /codelock/vanderbilt/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ApiEndpoint":"String","ApiPort":0,"Identifier":"String","DefaultFacilityId":0}