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.

import Foundation
import ServiceStack

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

    /**
    * 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")
    public var version:String

    required public init(){}
}

public enum VersionIdentifier : Int, Codable
{
    case BokaMeraiOS = 1
    case BokaMeraAdminiOS = 2
    case BokaMeraAndroid = 3
    case BokaMeraAdminAndroid = 4
}

public class ApiVersionCompabilityQueryResponse : Codable
{
    /**
    * The latest version number
    */
    public var currentVersion:String
    /**
    * Your version number
    */
    public var yourVersion:String
    /**
    * Any compatible error message
    */
    public var message:String
    /**
    * If your version is compatible with the current version
    */
    public var compatible:Bool
    /**
    * If the changes are blocking for use and you need to upgrade to later version
    */
    public var blockingChanges:Bool
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift ApiVersionCompabilityQuery DTOs

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
		}
	}
}