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

export class TokenResponse
{
    /** @description The token indentifier */
    // @ApiMember(Description="The token indentifier")
    public TokenIdentifier: string;

    public Type: number;
    /** @description The unique token */
    // @ApiMember(Description="The unique token", IsRequired=true)
    public UniqueToken: string;

    public ExpirationDate: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<TokenResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class GenerateToken
{
    /** @description The token identifier */
    // @ApiMember(Description="The token identifier")
    public TokenIdentifier: string;

    /** @description The token type */
    // @ApiMember(Description="The token type", IsRequired=true)
    public Type: number;

    /** @description The token expiration datetime */
    // @ApiMember(Description="The token expiration datetime", IsRequired=true)
    public ExpirationDate: string;

    /** @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)
    public UniqueToken: string;

    public constructor(init?: Partial<GenerateToken>) { (Object as any).assign(this, init); }
}

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