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 .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
		}
	}
}