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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiVersionQueryResponse:
    build_time: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    Timestamp when this API was built
    """

    sha: Optional[str] = None
    """
    The revision id from which the API was built
    """

    informational_version: Optional[str] = None
    """
    Full version information regarding the current running assemblies of the api
    """

    sem_ver: Optional[str] = None
    """
    The semantic version number of the current running api version, see www.semver.org for more information
    """

    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiVersionQuery:
    pass

Python 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: api.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"}}}