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.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class ApiKeyResponse
    {
        ///<summary>
        ///The company the API key belongs to
        ///</summary>
        [ApiMember(Description="The company the API key belongs to")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///The API key value to send in the x-api-key header
        ///</summary>
        [ApiMember(Description="The API key value to send in the x-api-key header")]
        public virtual Guid ApiKey { get; set; }

        ///<summary>
        ///Whether the key is active
        ///</summary>
        [ApiMember(Description="Whether the key is active")]
        public virtual bool Active { get; set; }

        ///<summary>
        ///When the key was created
        ///</summary>
        [ApiMember(Description="When the key was created")]
        public virtual DateTime CreatedDate { get; set; }

        ///<summary>
        ///When the key expires, if ever
        ///</summary>
        [ApiMember(Description="When the key expires, if ever")]
        public virtual DateTime? ExpiryDate { get; set; }

        ///<summary>
        ///Contact email registered for the key
        ///</summary>
        [ApiMember(Description="Contact email registered for the key")]
        public virtual string ContactEmail { get; set; }

        ///<summary>
        ///Free text notes for the key
        ///</summary>
        [ApiMember(Description="Free text notes for the key")]
        public virtual string Notes { get; set; }

        ///<summary>
        ///Comma separated list of IP addresses the key is restricted to, if any
        ///</summary>
        [ApiMember(Description="Comma separated list of IP addresses the key is restricted to, if any")]
        public virtual string AllowedIpAddresses { get; set; }
    }

    [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 partial class CreateApiKey
        : ICompany
    {
        ///<summary>
        ///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.
        ///</summary>
        [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 virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Optional contact email to register for the key. Defaults to the logged in user's email.
        ///</summary>
        [ApiMember(Description="Optional contact email to register for the key. Defaults to the logged in user's email.")]
        public virtual string ContactEmail { get; set; }

        ///<summary>
        ///Optional free text note for the key.
        ///</summary>
        [ApiMember(Description="Optional free text note for the key.")]
        public virtual string Notes { get; set; }
    }

}

C# CreateApiKey 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 /apikeys HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateApiKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ContactEmail>String</ContactEmail>
  <Notes>String</Notes>
</CreateApiKey>

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

<ApiKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <AllowedIpAddresses>String</AllowedIpAddresses>
  <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ContactEmail>String</ContactEmail>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <ExpiryDate>0001-01-01T00:00:00</ExpiryDate>
  <Notes>String</Notes>
</ApiKeyResponse>