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

class ApiKeySuperAdminResponse implements IConvertible
{
    // @ApiMember(IsRequired=true)
    String? CompanyId;

    // @ApiMember(IsRequired=true)
    String? ApiKey;

    // @ApiMember(IsRequired=true)
    String? Notes;

    // @ApiMember(IsRequired=true)
    String? InternalNotes;

    ApiKeySuperAdminResponse({this.CompanyId,this.ApiKey,this.Notes,this.InternalNotes});
    ApiKeySuperAdminResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

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

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

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

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

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'ApiKeySuperAdminResponse': TypeInfo(TypeOf.Class, create:() => ApiKeySuperAdminResponse()),
    'GetApiKeySuperAdminUser': TypeInfo(TypeOf.Class, create:() => GetApiKeySuperAdminUser()),
});

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