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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiVersionQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BuildTime>0001-01-01T00:00:00</BuildTime>
  <InformationalVersion>String</InformationalVersion>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SemVer>String</SemVer>
  <Sha>String</Sha>
</ApiVersionQueryResponse>