BokaMera.API.Host

<back to all web services

ApiVersionCompabilityQuery

The following routes are available for this service:
GET/version/compabilityGet information about if your current version is compability with the api verisonReturns information about which version of the API is currently running and when it was built.
ApiVersionCompabilityQuery Parameters:
NameParameterData TypeRequiredDescription
IdentifierqueryVersionIdentifierYesThe identifier for your application.
VersionquerystringYesThe version you are running and you want to check
VersionIdentifier Enum:
NameValue
BokaMeraiOS1
BokaMeraAdminiOS2
BokaMeraAndroid3
BokaMeraAdminAndroid4
ApiVersionCompabilityQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CurrentVersionformstringNoThe latest version number
YourVersionformstringNoYour version number
MessageformstringNoAny compatible error message
CompatibleformboolNoIf your version is compatible with the current version
BlockingChangesformboolNoIf the changes are blocking for use and you need to upgrade to later version
ResponseStatusformResponseStatusNo

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

HTTP + 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: api.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"}}}