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

public class dtos
{

    public static class ApiVersionQuery
    {
        
    }

    public static class ApiVersionQueryResponse
    {
        /**
        * Timestamp when this API was built
        */
        public Date BuildTime = null;
        /**
        * The revision id from which the API was built
        */
        public String Sha = null;
        /**
        * Full version information regarding the current running assemblies of the api
        */
        public String InformationalVersion = null;
        /**
        * The semantic version number of the current running api version, see www.semver.org for more information
        */
        public String SemVer = null;
        public ResponseStatus ResponseStatus = null;
        
        public Date getBuildTime() { return BuildTime; }
        public ApiVersionQueryResponse setBuildTime(Date value) { this.BuildTime = value; return this; }
        public String getSha() { return Sha; }
        public ApiVersionQueryResponse setSha(String value) { this.Sha = value; return this; }
        public String getInformationalVersion() { return InformationalVersion; }
        public ApiVersionQueryResponse setInformationalVersion(String value) { this.InformationalVersion = value; return this; }
        public String getSemVer() { return SemVer; }
        public ApiVersionQueryResponse setSemVer(String value) { this.SemVer = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ApiVersionQueryResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

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