BokaMera.API.Host

<back to all web services

ApiVersionQuery

The following routes are available for this service:
GET/versionGet information about this API's version and buildReturns information about which version of the API is currently running and when it was built.
import 'package:servicestack/servicestack.dart';

class ApiVersionQueryResponse implements IConvertible
{
    /**
    * Timestamp when this API was built
    */
    DateTime? BuildTime;
    /**
    * The revision id from which the API was built
    */
    String? Sha;
    /**
    * Full version information regarding the current running assemblies of the api
    */
    String? InformationalVersion;
    /**
    * The semantic version number of the current running api version, see www.semver.org for more information
    */
    String? SemVer;
    ResponseStatus? ResponseStatus;

    ApiVersionQueryResponse({this.BuildTime,this.Sha,this.InformationalVersion,this.SemVer,this.ResponseStatus});
    ApiVersionQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BuildTime = JsonConverters.fromJson(json['BuildTime'],'DateTime',context!);
        Sha = json['Sha'];
        InformationalVersion = json['InformationalVersion'];
        SemVer = json['SemVer'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BuildTime': JsonConverters.toJson(BuildTime,'DateTime',context!),
        'Sha': Sha,
        'InformationalVersion': InformationalVersion,
        'SemVer': SemVer,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class ApiVersionQuery implements IConvertible
{
    ApiVersionQuery();
    ApiVersionQuery.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

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

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

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

GET /version HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Sha: String,
	InformationalVersion: String,
	SemVer: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}