FirstChoice.API

GetApiKeys

auth

The following routes are available for this service:
All Verbs	/apikeys
All Verbs	/apikeys/{Environment}

import 'package:servicestack/servicestack.dart';

// @DataContract
class UserApiKey implements IMeta, IConvertible
{
    // @DataMember(Order=1)
    String? Key;

    // @DataMember(Order=2)
    String? KeyType;

    // @DataMember(Order=3)
    DateTime? ExpiryDate;

    // @DataMember(Order=4)
    Map<String,String?>? Meta;

    UserApiKey({this.Key,this.KeyType,this.ExpiryDate,this.Meta});
    UserApiKey.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Key = json['Key'];
        KeyType = json['KeyType'];
        ExpiryDate = JsonConverters.fromJson(json['ExpiryDate'],'DateTime',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Key': Key,
        'KeyType': KeyType,
        'ExpiryDate': JsonConverters.toJson(ExpiryDate,'DateTime',context!),
        'Meta': Meta
    };

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

// @DataContract
class GetApiKeysResponse implements IMeta, IConvertible
{
    // @DataMember(Order=1)
    List<UserApiKey>? Results;

    // @DataMember(Order=2)
    Map<String,String?>? Meta;

    // @DataMember(Order=3)
    ResponseStatus? ResponseStatus;

    GetApiKeysResponse({this.Results,this.Meta,this.ResponseStatus});
    GetApiKeysResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Results = JsonConverters.fromJson(json['Results'],'List<UserApiKey>',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Results': JsonConverters.toJson(Results,'List<UserApiKey>',context!),
        'Meta': Meta,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

// @DataContract
class GetApiKeys implements IGet, IMeta, IConvertible
{
    // @DataMember(Order=1)
    String? Environment;

    // @DataMember(Order=2)
    Map<String,String?>? Meta;

    GetApiKeys({this.Environment,this.Meta});
    GetApiKeys.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Environment = json['Environment'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

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

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

TypeContext _ctx = TypeContext(library: 'staging_api.my1stchoicefs.net', types: <String, TypeInfo> {
});

Dart GetApiKeys DTOs

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

HTTP + JSV

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

POST /apikeys HTTP/1.1 
Host: staging-api.my1stchoicefs.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Environment: String,
	Meta: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			Key: String,
			KeyType: String,
			ExpiryDate: 0001-01-01,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}