BokaMera.API.Host

CreateApiKey

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/apikeys	Create a new API key for the logged in user's company	Generates a new API key for the company of the currently logged in user and returns it. A company administrator can only create keys for their own company.

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="Returned if the current user is not authenticated", StatusCode=401)
    // @ApiResponse(Description="Returned if the current user does not have the required role", StatusCode=403)
    public static class CreateApiKey implements ICompany
    {
        /**
        * The company to create the API key for. Defaults to the logged in user's company. Only a SuperAdmin may specify a company other than their own; for other roles this value is ignored.
        */
        @ApiMember(Description="The company to create the API key for. Defaults to the logged in user's company. Only a SuperAdmin may specify a company other than their own; for other roles this value is ignored.")
        public UUID CompanyId = null;

        /**
        * Optional contact email to register for the key. Defaults to the logged in user's email.
        */
        @ApiMember(Description="Optional contact email to register for the key. Defaults to the logged in user's email.")
        public String ContactEmail = null;

        /**
        * Optional free text note for the key.
        */
        @ApiMember(Description="Optional free text note for the key.")
        public String Notes = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public CreateApiKey setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getContactEmail() { return ContactEmail; }
        public CreateApiKey setContactEmail(String value) { this.ContactEmail = value; return this; }
        public String getNotes() { return Notes; }
        public CreateApiKey setNotes(String value) { this.Notes = value; return this; }
    }

    public static class ApiKeyResponse
    {
        /**
        * The company the API key belongs to
        */
        @ApiMember(Description="The company the API key belongs to")
        public UUID CompanyId = null;

        /**
        * The API key value to send in the x-api-key header
        */
        @ApiMember(Description="The API key value to send in the x-api-key header")
        public UUID ApiKey = null;

        /**
        * Whether the key is active
        */
        @ApiMember(Description="Whether the key is active")
        public Boolean Active = null;

        /**
        * When the key was created
        */
        @ApiMember(Description="When the key was created")
        public Date CreatedDate = null;

        /**
        * When the key expires, if ever
        */
        @ApiMember(Description="When the key expires, if ever")
        public Date ExpiryDate = null;

        /**
        * Contact email registered for the key
        */
        @ApiMember(Description="Contact email registered for the key")
        public String ContactEmail = null;

        /**
        * Free text notes for the key
        */
        @ApiMember(Description="Free text notes for the key")
        public String Notes = null;

        /**
        * Comma separated list of IP addresses the key is restricted to, if any
        */
        @ApiMember(Description="Comma separated list of IP addresses the key is restricted to, if any")
        public String AllowedIpAddresses = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public ApiKeyResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public UUID getApiKey() { return ApiKey; }
        public ApiKeyResponse setApiKey(UUID value) { this.ApiKey = value; return this; }
        public Boolean isActive() { return Active; }
        public ApiKeyResponse setActive(Boolean value) { this.Active = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public ApiKeyResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public Date getExpiryDate() { return ExpiryDate; }
        public ApiKeyResponse setExpiryDate(Date value) { this.ExpiryDate = value; return this; }
        public String getContactEmail() { return ContactEmail; }
        public ApiKeyResponse setContactEmail(String value) { this.ContactEmail = value; return this; }
        public String getNotes() { return Notes; }
        public ApiKeyResponse setNotes(String value) { this.Notes = value; return this; }
        public String getAllowedIpAddresses() { return AllowedIpAddresses; }
        public ApiKeyResponse setAllowedIpAddresses(String value) { this.AllowedIpAddresses = value; return this; }
    }

}

Java CreateApiKey DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /apikeys HTTP/1.1 
Host: api.bookmore.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ContactEmail":"String","Notes":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Active":false,"ExpiryDate":"0001-01-01T00:00:00","ContactEmail":"String","Notes":"String","AllowedIpAddresses":"String"}