GET | /version/compability | Get information about if your current version is compability with the api verison | Returns information about which version of the API is currently running and when it was built. |
---|
"use strict";
export class ApiVersionCompabilityQueryResponse {
/** @param {{CurrentVersion?:string,YourVersion?:string,Message?:string,Compatible?:boolean,BlockingChanges?:boolean,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The latest version number */
CurrentVersion;
/**
* @type {string}
* @description Your version number */
YourVersion;
/**
* @type {string}
* @description Any compatible error message */
Message;
/**
* @type {boolean}
* @description If your version is compatible with the current version */
Compatible;
/**
* @type {boolean}
* @description If the changes are blocking for use and you need to upgrade to later version */
BlockingChanges;
/** @type {ResponseStatus} */
ResponseStatus;
}
/** @typedef {number} */
export var VersionIdentifier;
(function (VersionIdentifier) {
VersionIdentifier[VersionIdentifier["BokaMeraiOS"] = 1] = "BokaMeraiOS"
VersionIdentifier[VersionIdentifier["BokaMeraAdminiOS"] = 2] = "BokaMeraAdminiOS"
VersionIdentifier[VersionIdentifier["BokaMeraAndroid"] = 3] = "BokaMeraAndroid"
VersionIdentifier[VersionIdentifier["BokaMeraAdminAndroid"] = 4] = "BokaMeraAdminAndroid"
})(VersionIdentifier || (VersionIdentifier = {}));
export class ApiVersionCompabilityQuery {
/** @param {{Identifier?:VersionIdentifier,Version?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {VersionIdentifier}
* @description The identifier for your application. */
Identifier;
/**
* @type {string}
* @description The version you are running and you want to check */
Version;
}
JavaScript ApiVersionCompabilityQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /version/compability HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"CurrentVersion":"String","YourVersion":"String","Message":"String","Compatible":false,"BlockingChanges":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}