BokaMera.API.Host

<back to all web services

GetApiKeySuperAdminUser

Requires Authentication
Required role:superadmin
The following routes are available for this service:
GET/superadmin/apikey/{CompanyId}Get an api key for the customer.
import Foundation
import ServiceStack

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

    required public init(){}
}

public class ApiKeySuperAdminResponse : Codable
{
    // @ApiMember(IsRequired=true)
    public var companyId:String

    // @ApiMember(IsRequired=true)
    public var apiKey:String

    // @ApiMember(IsRequired=true)
    public var notes:String

    // @ApiMember(IsRequired=true)
    public var internalNotes:String

    required public init(){}
}


Swift GetApiKeySuperAdminUser 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.

GET /superadmin/apikey/{CompanyId} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
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>