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
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TokenResponse() = 
        ///<summary>
        ///The token indentifier
        ///</summary>
        [<ApiMember(Description="The token indentifier")>]
        member val TokenIdentifier:String = null with get,set

        member val Type:Int32 = new Int32() with get,set
        ///<summary>
        ///The unique token
        ///</summary>
        [<ApiMember(Description="The unique token", IsRequired=true)>]
        member val UniqueToken:String = null with get,set

        member val ExpirationDate:DateTime = new DateTime() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type GenerateToken() = 
        ///<summary>
        ///The token identifier
        ///</summary>
        [<ApiMember(Description="The token identifier")>]
        member val TokenIdentifier:String = null with get,set

        ///<summary>
        ///The token type
        ///</summary>
        [<ApiMember(Description="The token type", IsRequired=true)>]
        member val Type:Int32 = new Int32() with get,set

        ///<summary>
        ///The token expiration datetime
        ///</summary>
        [<ApiMember(Description="The token expiration datetime", IsRequired=true)>]
        member val ExpirationDate:DateTime = new DateTime() with get,set

        ///<summary>
        ///The unique token.If empty a unique token will be generated automatically
        ///</summary>
        [<ApiMember(Description="The unique token.If empty a unique token will be generated automatically", IsRequired=true)>]
        member val UniqueToken:String = null with get,set

F# 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
		}
	}
}