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.
"use strict";
export class ApiVersionQueryResponse {
    /** @param {{BuildTime?:string,Sha?:string,InformationalVersion?:string,SemVer?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Timestamp when this API was built */
    BuildTime;
    /**
     * @type {string}
     * @description The revision id from which the API was built */
    Sha;
    /**
     * @type {string}
     * @description Full version information regarding the current running assemblies of the api */
    InformationalVersion;
    /**
     * @type {string}
     * @description The semantic version number of the current running api version, see www.semver.org for more information */
    SemVer;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ApiVersionQuery {
    constructor(init) { Object.assign(this, init) }
}

JavaScript ApiVersionQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}