BokaMera.API.Host

ApiVersionCompabilityQuery

The following routes are available for this service:
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.

namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiVersionCompabilityQueryResponse() = 
        ///<summary>
        ///The latest version number
        ///</summary>
        member val CurrentVersion:String = null with get,set

        ///<summary>
        ///Your version number
        ///</summary>
        member val YourVersion:String = null with get,set

        ///<summary>
        ///Any compatible error message
        ///</summary>
        member val Message:String = null with get,set

        ///<summary>
        ///If your version is compatible with the current version
        ///</summary>
        member val Compatible:Boolean = new Boolean() with get,set

        ///<summary>
        ///If the changes are blocking for use and you need to upgrade to later version
        ///</summary>
        member val BlockingChanges:Boolean = new Boolean() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    type VersionIdentifier =
        | BokaMeraiOS = 1
        | BokaMeraAdminiOS = 2
        | BokaMeraAndroid = 3
        | BokaMeraAdminAndroid = 4

    [<AllowNullLiteral>]
    type ApiVersionCompabilityQuery() = 
        ///<summary>
        ///The identifier for your application.
        ///</summary>
        [<ApiMember(Description="The identifier for your application.", IsRequired=true, ParameterType="query")>]
        member val Identifier:VersionIdentifier = new VersionIdentifier() with get,set

        ///<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")>]
        member val Version:String = null with get,set

F# 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: 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>