BokaMera.API.Host

<back to all web services

CreateApiKeySuperAdminUser

Requires Authentication
Required role:superadmin
The following routes are available for this service:
POST/superadmin/apikeyCreates an api key for the customer.
"use strict";
export class ApiKeySuperAdminResponse {
    /** @param {{CompanyId?:string,ApiKey?:string,Notes?:string,InternalNotes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    ApiKey;
    /** @type {string} */
    Notes;
    /** @type {string} */
    InternalNotes;
}
export class CreateApiKeySuperAdminUser {
    /** @param {{CompanyId?:string,FirstName?:string,LastName?:string,ContactEmail?:string,ContactPhone?:string,Notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Enter the companyId for the customer */
    CompanyId;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    ContactEmail;
    /** @type {string} */
    ContactPhone;
    /** @type {string} */
    Notes;
}

JavaScript CreateApiKeySuperAdminUser 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 /superadmin/apikey HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateApiKeySuperAdminUser 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>
  <ContactPhone>String</ContactPhone>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <Notes>String</Notes>
</CreateApiKeySuperAdminUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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