BokaMera.API.Host

<back to all web services

CreateApiKeySuperAdminUser

The following routes are available for this service:
POST/superadmin/apikeyCreates an api key for the customer.
import 'package:servicestack/servicestack.dart';

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

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

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

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

    // @ApiMember(IsRequired=true)
    List<String>? RedirectUrls;

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

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

    // @ApiMember()
    String? Notes;

    // @ApiMember()
    List<String>? WebOrigins;

    // @ApiMember()
    List<String>? DefaultClientScopes;

    // @ApiMember()
    List<String>? OptionalClientScopes;

    CreateApiKeySuperAdminUser({this.CompanyId,this.FirstName,this.LastName,this.ClientId,this.RedirectUrls,this.ContactEmail,this.ContactPhone,this.Notes,this.WebOrigins,this.DefaultClientScopes,this.OptionalClientScopes});
    CreateApiKeySuperAdminUser.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        FirstName = json['FirstName'];
        LastName = json['LastName'];
        ClientId = json['ClientId'];
        RedirectUrls = JsonConverters.fromJson(json['RedirectUrls'],'List<String>',context!);
        ContactEmail = json['ContactEmail'];
        ContactPhone = json['ContactPhone'];
        Notes = json['Notes'];
        WebOrigins = JsonConverters.fromJson(json['WebOrigins'],'List<String>',context!);
        DefaultClientScopes = JsonConverters.fromJson(json['DefaultClientScopes'],'List<String>',context!);
        OptionalClientScopes = JsonConverters.fromJson(json['OptionalClientScopes'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'FirstName': FirstName,
        'LastName': LastName,
        'ClientId': ClientId,
        'RedirectUrls': JsonConverters.toJson(RedirectUrls,'List<String>',context!),
        'ContactEmail': ContactEmail,
        'ContactPhone': ContactPhone,
        'Notes': Notes,
        'WebOrigins': JsonConverters.toJson(WebOrigins,'List<String>',context!),
        'DefaultClientScopes': JsonConverters.toJson(DefaultClientScopes,'List<String>',context!),
        'OptionalClientScopes': JsonConverters.toJson(OptionalClientScopes,'List<String>',context!)
    };

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

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

Dart 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: api.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">
  <ClientId>String</ClientId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ContactEmail>String</ContactEmail>
  <ContactPhone>String</ContactPhone>
  <DefaultClientScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DefaultClientScopes>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <Notes>String</Notes>
  <OptionalClientScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OptionalClientScopes>
  <RedirectUrls xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RedirectUrls>
  <WebOrigins xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </WebOrigins>
</CreateApiKeySuperAdminUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />