BokaMera.API.Host

<back to all web services

UpdateParakeyCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/parakey/settingsUpdate settings for the code lock of the company of the currently logged in userUpdate settings for code lock of the company of 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 CodeLockParakeySettingResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $CompanyId='',
        /** @description The domain id of the code lock. */
        // @ApiMember(DataType="string", Description="The domain id of the code lock.")
        /** @var string|null */
        public ?string $DomainId=null,

        /** @description The access token of the code lock. */
        // @ApiMember(DataType="string", Description="The access token of the code lock.")
        /** @var string|null */
        public ?string $AccessToken=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['DomainId'])) $this->DomainId = $o['DomainId'];
        if (isset($o['AccessToken'])) $this->AccessToken = $o['AccessToken'];
        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->DomainId)) $o['DomainId'] = $this->DomainId;
        if (isset($this->AccessToken)) $o['AccessToken'] = $this->AccessToken;
        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 UpdateParakeyCodeLockSetting 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,

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

        /** @description The access token of the code lock. */
        // @ApiMember(DataType="string", Description="The access token of the code lock.")
        /** @var string|null */
        public ?string $AccessToken=null
    ) {
    }

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

PHP UpdateParakeyCodeLockSetting DTOs

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

HTTP + XML

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

PUT /codelock/parakey/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateParakeyCodeLockSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AccessToken>String</AccessToken>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <DomainId>String</DomainId>
</UpdateParakeyCodeLockSetting>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockParakeySettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AccessToken>String</AccessToken>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <DomainId>String</DomainId>
  <Updated>0001-01-01T00:00:00</Updated>
</CodeLockParakeySettingResponse>