BokaMera.API.Host

GenerateToken

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

The following routes are available for this service:
POST	/token	Add new token

<?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 TokenResponse implements JsonSerializable
{
    public function __construct(
        /** @description The token indentifier */
        // @ApiMember(Description="The token indentifier")
        /** @var string|null */
        public ?string $TokenIdentifier=null,

        /** @var int */
        public int $Type=0,
        /** @description The unique token */
        // @ApiMember(Description="The unique token", IsRequired=true)
        /** @var string */
        public string $UniqueToken='',

        /** @var DateTime */
        public DateTime $ExpirationDate=new DateTime(),
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TokenIdentifier'])) $this->TokenIdentifier = $o['TokenIdentifier'];
        if (isset($o['Type'])) $this->Type = $o['Type'];
        if (isset($o['UniqueToken'])) $this->UniqueToken = $o['UniqueToken'];
        if (isset($o['ExpirationDate'])) $this->ExpirationDate = JsonConverters::from('DateTime', $o['ExpirationDate']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TokenIdentifier)) $o['TokenIdentifier'] = $this->TokenIdentifier;
        if (isset($this->Type)) $o['Type'] = $this->Type;
        if (isset($this->UniqueToken)) $o['UniqueToken'] = $this->UniqueToken;
        if (isset($this->ExpirationDate)) $o['ExpirationDate'] = JsonConverters::to('DateTime', $this->ExpirationDate);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class GenerateToken implements JsonSerializable
{
    public function __construct(
        /** @description The token identifier */
        // @ApiMember(Description="The token identifier")
        /** @var string|null */
        public ?string $TokenIdentifier=null,

        /** @description The token type */
        // @ApiMember(Description="The token type", IsRequired=true)
        /** @var int */
        public int $Type=0,

        /** @description The token expiration datetime */
        // @ApiMember(Description="The token expiration datetime", IsRequired=true)
        /** @var DateTime */
        public DateTime $ExpirationDate=new DateTime(),

        /** @description The unique token.If empty a unique token will be generated automatically */
        // @ApiMember(Description="The unique token.If empty a unique token will be generated automatically", IsRequired=true)
        /** @var string */
        public string $UniqueToken=''
    ) {
    }

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

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

POST /token HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <TokenIdentifier>String</TokenIdentifier>
  <Type>0</Type>
  <UniqueToken>String</UniqueToken>
</GenerateToken>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <TokenIdentifier>String</TokenIdentifier>
  <Type>0</Type>
  <UniqueToken>String</UniqueToken>
</TokenResponse>