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