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 'package:servicestack/servicestack.dart';

class ApiKeyResponse implements IConvertible
{
    /**
    * The company the API key belongs to
    */
    // @ApiMember(Description="The company the API key belongs to")
    String CompanyId = "";

    /**
    * 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")
    String ApiKey = "";

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

    /**
    * When the key was created
    */
    // @ApiMember(Description="When the key was created")
    DateTime CreatedDate = DateTime(0);

    /**
    * When the key expires, if ever
    */
    // @ApiMember(Description="When the key expires, if ever")
    DateTime? ExpiryDate;

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

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

    /**
    * 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")
    String AllowedIpAddresses = "";

    ApiKeyResponse({this.CompanyId,this.ApiKey,this.Active,this.CreatedDate,this.ExpiryDate,this.ContactEmail,this.Notes,this.AllowedIpAddresses});
    ApiKeyResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        ApiKey = json['ApiKey'];
        Active = json['Active'];
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        ExpiryDate = JsonConverters.fromJson(json['ExpiryDate'],'DateTime',context!);
        ContactEmail = json['ContactEmail'];
        Notes = json['Notes'];
        AllowedIpAddresses = json['AllowedIpAddresses'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'ApiKey': ApiKey,
        'Active': Active,
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'ExpiryDate': JsonConverters.toJson(ExpiryDate,'DateTime',context!),
        'ContactEmail': ContactEmail,
        'Notes': Notes,
        'AllowedIpAddresses': AllowedIpAddresses
    };

    getTypeName() => "ApiKeyResponse";
    TypeContext? context = _ctx;
}

// @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)
class CreateApiKey implements ICompany, IConvertible
{
    /**
    * 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.")
    String? CompanyId;

    /**
    * 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.")
    String ContactEmail = "";

    /**
    * Optional free text note for the key.
    */
    // @ApiMember(Description="Optional free text note for the key.")
    String Notes = "";

    CreateApiKey({this.CompanyId,this.ContactEmail,this.Notes});
    CreateApiKey.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        ContactEmail = json['ContactEmail'];
        Notes = json['Notes'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'ContactEmail': ContactEmail,
        'Notes': Notes
    };

    getTypeName() => "CreateApiKey";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bookmore.com', types: <String, TypeInfo> {
    'ApiKeyResponse': TypeInfo(TypeOf.Class, create:() => ApiKeyResponse()),
    'CreateApiKey': TypeInfo(TypeOf.Class, create:() => CreateApiKey()),
});

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