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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class GenerateToken
            '''<Summary>
            '''The token identifier
            '''</Summary>
            <ApiMember(Description:="The token identifier")>
            Public Overridable Property TokenIdentifier As String

            '''<Summary>
            '''The token type
            '''</Summary>
            <ApiMember(Description:="The token type", IsRequired:=true)>
            Public Overridable Property Type As Integer

            '''<Summary>
            '''The token expiration datetime
            '''</Summary>
            <ApiMember(Description:="The token expiration datetime", IsRequired:=true)>
            Public Overridable Property ExpirationDate As Date

            '''<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)>
            Public Overridable Property UniqueToken As String
        End Class

        Public Partial Class TokenResponse
            '''<Summary>
            '''The token indentifier
            '''</Summary>
            <ApiMember(Description:="The token indentifier")>
            Public Overridable Property TokenIdentifier As String

            Public Overridable Property Type As Integer
            '''<Summary>
            '''The unique token
            '''</Summary>
            <ApiMember(Description:="The unique token", IsRequired:=true)>
            Public Overridable Property UniqueToken As String

            Public Overridable Property ExpirationDate As Date
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

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