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.
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 ApiVersionQueryResponse() = 
        ///<summary>
        ///Timestamp when this API was built
        ///</summary>
        member val BuildTime:DateTime = new DateTime() with get,set

        ///<summary>
        ///The revision id from which the API was built
        ///</summary>
        member val Sha:String = null with get,set

        ///<summary>
        ///Full version information regarding the current running assemblies of the api
        ///</summary>
        member val InformationalVersion:String = null with get,set

        ///<summary>
        ///The semantic version number of the current running api version, see www.semver.org for more information
        ///</summary>
        member val SemVer:String = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ApiVersionQuery() = 
        class end

F# 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: testapi.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
		}
	}
}