BokaMera.API.Host

ApiVersionCompabilityQuery

The following routes are available for this service:
GET	/version/compability	Get information about whether your current version is compatible with the API version	Returns information on whether the client application's version is compatible with the current API version, indicating any breaking changes.

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Enums

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class ApiVersionCompabilityQuery
            '''<Summary>
            '''The identifier for your application.
            '''</Summary>
            <ApiMember(Description:="The identifier for your application.", IsRequired:=true, ParameterType:="query")>
            Public Overridable Property Identifier As VersionIdentifier

            '''<Summary>
            '''The version you are running and you want to check
            '''</Summary>
            <ApiMember(Description:="The version you are running and you want to check", IsRequired:=true, ParameterType:="query")>
            Public Overridable Property Version As String
        End Class

        Public Partial Class ApiVersionCompabilityQueryResponse
            '''<Summary>
            '''The latest version number
            '''</Summary>
            Public Overridable Property CurrentVersion As String
            '''<Summary>
            '''Your version number
            '''</Summary>
            Public Overridable Property YourVersion As String
            '''<Summary>
            '''Any compatible error message
            '''</Summary>
            Public Overridable Property Message As String
            '''<Summary>
            '''If your version is compatible with the current version
            '''</Summary>
            Public Overridable Property Compatible As Boolean
            '''<Summary>
            '''If the changes are blocking for use and you need to upgrade to later version
            '''</Summary>
            Public Overridable Property BlockingChanges As Boolean
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Enums

        Public Enum VersionIdentifier
            BokaMeraiOS = 1
            BokaMeraAdminiOS = 2
            BokaMeraAndroid = 3
            BokaMeraAdminAndroid = 4
        End Enum
    End Namespace
End Namespace

VB.NET ApiVersionCompabilityQuery 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/compability HTTP/1.1 
Host: api.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>