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.
import java.math.*
import java.util.*
import net.servicestack.client.*


open class ApiVersionCompabilityQuery
{
    /**
    * The identifier for your application.
    */
    @ApiMember(Description="The identifier for your application.", IsRequired=true, ParameterType="query")
    var Identifier:VersionIdentifier? = null

    /**
    * The version you are running and you want to check
    */
    @ApiMember(Description="The version you are running and you want to check", IsRequired=true, ParameterType="query")
    var Version:String? = null
}

enum class VersionIdentifier(val value:Int)
{
    BokaMeraiOS(1),
    BokaMeraAdminiOS(2),
    BokaMeraAndroid(3),
    BokaMeraAdminAndroid(4),
}

open class ApiVersionCompabilityQueryResponse
{
    /**
    * The latest version number
    */
    var CurrentVersion:String? = null
    /**
    * Your version number
    */
    var YourVersion:String? = null
    /**
    * Any compatible error message
    */
    var Message:String? = null
    /**
    * If your version is compatible with the current version
    */
    var Compatible:Boolean? = null
    /**
    * If the changes are blocking for use and you need to upgrade to later version
    */
    var BlockingChanges:Boolean? = null
    var ResponseStatus:ResponseStatus? = null
}

Kotlin ApiVersionCompabilityQuery DTOs

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

HTTP + CSV

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