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 'package:servicestack/servicestack.dart';

class TokenResponse implements IConvertible
{
    /**
    * The token indentifier
    */
    // @ApiMember(Description="The token indentifier")
    String? TokenIdentifier;

    int? Type;
    /**
    * The unique token
    */
    // @ApiMember(Description="The unique token", IsRequired=true)
    String? UniqueToken;

    DateTime? ExpirationDate;
    ResponseStatus? ResponseStatus;

    TokenResponse({this.TokenIdentifier,this.Type,this.UniqueToken,this.ExpirationDate,this.ResponseStatus});
    TokenResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TokenIdentifier = json['TokenIdentifier'];
        Type = json['Type'];
        UniqueToken = json['UniqueToken'];
        ExpirationDate = JsonConverters.fromJson(json['ExpirationDate'],'DateTime',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TokenIdentifier': TokenIdentifier,
        'Type': Type,
        'UniqueToken': UniqueToken,
        'ExpirationDate': JsonConverters.toJson(ExpirationDate,'DateTime',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "TokenResponse";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class GenerateToken implements IConvertible
{
    /**
    * The token identifier
    */
    // @ApiMember(Description="The token identifier")
    String? TokenIdentifier;

    /**
    * The token type
    */
    // @ApiMember(Description="The token type", IsRequired=true)
    int? Type;

    /**
    * The token expiration datetime
    */
    // @ApiMember(Description="The token expiration datetime", IsRequired=true)
    DateTime? ExpirationDate;

    /**
    * 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)
    String? UniqueToken;

    GenerateToken({this.TokenIdentifier,this.Type,this.ExpirationDate,this.UniqueToken});
    GenerateToken.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TokenIdentifier = json['TokenIdentifier'];
        Type = json['Type'];
        ExpirationDate = JsonConverters.fromJson(json['ExpirationDate'],'DateTime',context!);
        UniqueToken = json['UniqueToken'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TokenIdentifier': TokenIdentifier,
        'Type': Type,
        'ExpirationDate': JsonConverters.toJson(ExpirationDate,'DateTime',context!),
        'UniqueToken': UniqueToken
    };

    getTypeName() => "GenerateToken";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'TokenResponse': TypeInfo(TypeOf.Class, create:() => TokenResponse()),
    'GenerateToken': TypeInfo(TypeOf.Class, create:() => GenerateToken()),
});

Dart 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>