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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

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

        /**
        * The token type
        */
        @ApiMember(Description="The token type", IsRequired=true)
        public Integer Type = null;

        /**
        * The token expiration datetime
        */
        @ApiMember(Description="The token expiration datetime", IsRequired=true)
        public Date ExpirationDate = null;

        /**
        * 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 String UniqueToken = null;
        
        public String getTokenIdentifier() { return TokenIdentifier; }
        public GenerateToken setTokenIdentifier(String value) { this.TokenIdentifier = value; return this; }
        public Integer getType() { return Type; }
        public GenerateToken setType(Integer value) { this.Type = value; return this; }
        public Date getExpirationDate() { return ExpirationDate; }
        public GenerateToken setExpirationDate(Date value) { this.ExpirationDate = value; return this; }
        public String getUniqueToken() { return UniqueToken; }
        public GenerateToken setUniqueToken(String value) { this.UniqueToken = value; return this; }
    }

    public static class TokenResponse
    {
        /**
        * The token indentifier
        */
        @ApiMember(Description="The token indentifier")
        public String TokenIdentifier = null;

        public Integer Type = null;
        /**
        * The unique token
        */
        @ApiMember(Description="The unique token", IsRequired=true)
        public String UniqueToken = null;

        public Date ExpirationDate = null;
        public ResponseStatus ResponseStatus = null;
        
        public String getTokenIdentifier() { return TokenIdentifier; }
        public TokenResponse setTokenIdentifier(String value) { this.TokenIdentifier = value; return this; }
        public Integer getType() { return Type; }
        public TokenResponse setType(Integer value) { this.Type = value; return this; }
        public String getUniqueToken() { return UniqueToken; }
        public TokenResponse setUniqueToken(String value) { this.UniqueToken = value; return this; }
        public Date getExpirationDate() { return ExpirationDate; }
        public TokenResponse setExpirationDate(Date value) { this.ExpirationDate = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public TokenResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

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