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


@ApiResponse(Description="", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
open class CreateApiKeySuperAdminUser : ICompany
{
    /**
    * Enter the companyId for the customer
    */
    @ApiMember(Description="Enter the companyId for the customer", IsRequired=true, ParameterType="query")
    var CompanyId:UUID? = null

    @ApiMember(IsRequired=true)
    var FirstName:String? = null

    @ApiMember(IsRequired=true)
    var LastName:String? = null

    @ApiMember(IsRequired=true)
    var ContactEmail:String? = null

    @ApiMember(IsRequired=true)
    var ContactPhone:String? = null

    @ApiMember()
    var Notes:String? = null
}

open class ApiKeySuperAdminResponse
{
    @ApiMember(IsRequired=true)
    var CompanyId:UUID? = null

    @ApiMember(IsRequired=true)
    var ApiKey:UUID? = null

    @ApiMember(IsRequired=true)
    var Notes:String? = null

    @ApiMember(IsRequired=true)
    var InternalNotes:String? = null
}

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