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. |
---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiVersionCompabilityQueryResponse() =
///<summary>
///The latest version number
///</summary>
member val CurrentVersion:String = null with get,set
///<summary>
///Your version number
///</summary>
member val YourVersion:String = null with get,set
///<summary>
///Any compatible error message
///</summary>
member val Message:String = null with get,set
///<summary>
///If your version is compatible with the current version
///</summary>
member val Compatible:Boolean = new Boolean() with get,set
///<summary>
///If the changes are blocking for use and you need to upgrade to later version
///</summary>
member val BlockingChanges:Boolean = new Boolean() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
type VersionIdentifier =
| BokaMeraiOS = 1
| BokaMeraAdminiOS = 2
| BokaMeraAndroid = 3
| BokaMeraAdminAndroid = 4
[<AllowNullLiteral>]
type ApiVersionCompabilityQuery() =
///<summary>
///The identifier for your application.
///</summary>
[<ApiMember(Description="The identifier for your application.", IsRequired=true, ParameterType="query")>]
member val Identifier:VersionIdentifier = new VersionIdentifier() with get,set
///<summary>
///The version you are running and you want to check
///</summary>
[<ApiMember(Description="The version you are running and you want to check", IsRequired=true, ParameterType="query")>]
member val Version:String = null with get,set
F# 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: 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"}}}