BokaMera.API.Host

<back to all web services

ApiVersionQuery

The following routes are available for this service:
GET/versionGet information about this API's version and buildReturns information about which version of the API is currently running and when it was built.
import Foundation
import ServiceStack

public class ApiVersionQuery : Codable
{
    required public init(){}
}

public class ApiVersionQueryResponse : Codable
{
    /**
    * Timestamp when this API was built
    */
    public var buildTime:Date
    /**
    * The revision id from which the API was built
    */
    public var sha:String
    /**
    * Full version information regarding the current running assemblies of the api
    */
    public var informationalVersion:String
    /**
    * The semantic version number of the current running api version, see www.semver.org for more information
    */
    public var semVer:String
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift ApiVersionQuery 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 HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Sha: String,
	InformationalVersion: String,
	SemVer: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}