BokaMera.API.Host

<back to all web services

GenerateToken

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/tokenAdd new token
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TokenResponse:
    # @ApiMember(Description="The token indentifier")
    token_identifier: Optional[str] = None
    """
    The token indentifier
    """


    type: int = 0
    # @ApiMember(Description="The unique token", IsRequired=true)
    unique_token: Optional[str] = None
    """
    The unique token
    """


    expiration_date: datetime.datetime = datetime.datetime(1, 1, 1)
    response_status: Optional[ResponseStatus] = None


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GenerateToken:
    # @ApiMember(Description="The token identifier")
    token_identifier: Optional[str] = None
    """
    The token identifier
    """


    # @ApiMember(Description="The token type", IsRequired=true)
    type: int = 0
    """
    The token type
    """


    # @ApiMember(Description="The token expiration datetime", IsRequired=true)
    expiration_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The token expiration datetime
    """


    # @ApiMember(Description="The unique token.If empty a unique token will be generated automatically", IsRequired=true)
    unique_token: Optional[str] = None
    """
    The unique token.If empty a unique token will be generated automatically
    """

Python GenerateToken DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TokenIdentifier: String,
	Type: 0,
	UniqueToken: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TokenIdentifier: String,
	Type: 0,
	UniqueToken: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}