| 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 .xml suffix or ?format=xml
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: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ApiVersionCompabilityQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BlockingChanges>false</BlockingChanges>
<Compatible>false</Compatible>
<CurrentVersion>String</CurrentVersion>
<Message>String</Message>
<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>
<YourVersion>String</YourVersion>
</ApiVersionCompabilityQueryResponse>