| GET | /version/compability | Get information about if your current version is compability with the api verison | Returns 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 ApiVersionCompabilityQueryResponse:
current_version: Optional[str] = None
"""
The latest version number
"""
your_version: Optional[str] = None
"""
Your version number
"""
message: Optional[str] = None
"""
Any compatible error message
"""
compatible: bool = False
"""
If your version is compatible with the current version
"""
blocking_changes: bool = False
"""
If the changes are blocking for use and you need to upgrade to later version
"""
response_status: Optional[ResponseStatus] = None
class VersionIdentifier(IntEnum):
BOKA_MERAI_O_S = 1
BOKA_MERA_ADMINI_O_S = 2
BOKA_MERA_ANDROID = 3
BOKA_MERA_ADMIN_ANDROID = 4
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiVersionCompabilityQuery:
# @ApiMember(Description="The identifier for your application.", IsRequired=true, ParameterType="query")
identifier: Optional[VersionIdentifier] = None
"""
The identifier for your application.
"""
# @ApiMember(Description="The version you are running and you want to check", IsRequired=true, ParameterType="query")
version: Optional[str] = None
"""
The version you are running and you want to check
"""
Python ApiVersionCompabilityQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /version/compability HTTP/1.1 Host: api.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"CurrentVersion":"String","YourVersion":"String","Message":"String","Compatible":false,"BlockingChanges":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}