Foundry API

CreateApiKeyRequest

The following routes are available for this service:
POST	/auth/apikey

import 'package:servicestack/servicestack.dart';

abstract class PostOperationUnTenanted<TResponse> implements IPost
{
    PostOperationUnTenanted();
    PostOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PostOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class ApiKey implements IIdentifiableResource, IConvertible
{
    String? userId;
    String? description;
    DateTime? expiresUtc;
    String? key;
    String? id;

    ApiKey({this.userId,this.description,this.expiresUtc,this.key,this.id});
    ApiKey.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        userId = json['userId'];
        description = json['description'];
        expiresUtc = JsonConverters.fromJson(json['expiresUtc'],'DateTime',context!);
        key = json['key'];
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userId': userId,
        'description': description,
        'expiresUtc': JsonConverters.toJson(expiresUtc,'DateTime',context!),
        'key': key,
        'id': id
    };

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

class CreateApiKeyResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    ApiKey? apiKey;

    CreateApiKeyResponse({this.responseStatus,this.apiKey});
    CreateApiKeyResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        apiKey = JsonConverters.fromJson(json['apiKey'],'ApiKey',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'apiKey': JsonConverters.toJson(apiKey,'ApiKey',context!)
    };

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

class CreateApiKeyRequest extends PostOperationUnTenanted<CreateApiKeyResponse> implements IConvertible
{
    String? description;
    DateTime? expiresUtc;

    CreateApiKeyRequest({this.description,this.expiresUtc});
    CreateApiKeyRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        description = json['description'];
        expiresUtc = JsonConverters.fromJson(json['expiresUtc'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'description': description,
        'expiresUtc': JsonConverters.toJson(expiresUtc,'DateTime',context!)
    });

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

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'ApiKey': TypeInfo(TypeOf.Class, create:() => ApiKey()),
    'CreateApiKeyResponse': TypeInfo(TypeOf.Class, create:() => CreateApiKeyResponse()),
    'CreateApiKeyRequest': TypeInfo(TypeOf.Class, create:() => CreateApiKeyRequest()),
});

Dart CreateApiKeyRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /auth/apikey HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"description":"String","expiresUtc":null}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"apiKey":{"userId":"String","description":"String","expiresUtc":null,"key":"String","id":"String"}}