BokaMera.API.Host

ApiVersionCompabilityQuery

The following routes are available for this service:
GET	/version/compability	Get information about whether your current version is compatible with the API version	Returns information on whether the client application's version is compatible with the current API version, indicating any breaking changes.

**ApiVersionCompabilityQuery** Parameters:
Name	Parameter	Data Type	Required	Description
Identifier	query	VersionIdentifier	Yes	The identifier for your application.
Version	query	string	Yes	The version you are running and you want to check

**VersionIdentifier** Enum:
Name	Value
BokaMeraiOS	1
BokaMeraAdminiOS	2
BokaMeraAndroid	3
BokaMeraAdminAndroid	4

**ApiVersionCompabilityQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CurrentVersion	form	string	Yes	The latest version number
YourVersion	form	string	Yes	Your version number
Message	form	string	Yes	Any compatible error message
Compatible	form	bool	No	If your version is compatible with the current version
BlockingChanges	form	bool	No	If the changes are blocking for use and you need to upgrade to later version
ResponseStatus	form	ResponseStatus	Yes

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/compability HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}