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.

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ApiVersionCompabilityQuery
    {
        /**
        * The identifier for your application.
        */
        @ApiMember(Description="The identifier for your application.", IsRequired=true, ParameterType="query")
        public VersionIdentifier Identifier = null;

        /**
        * The version you are running and you want to check
        */
        @ApiMember(Description="The version you are running and you want to check", IsRequired=true, ParameterType="query")
        public String Version = null;
        
        public VersionIdentifier getIdentifier() { return Identifier; }
        public ApiVersionCompabilityQuery setIdentifier(VersionIdentifier value) { this.Identifier = value; return this; }
        public String getVersion() { return Version; }
        public ApiVersionCompabilityQuery setVersion(String value) { this.Version = value; return this; }
    }

    public static enum VersionIdentifier
    {
        BokaMeraiOS(1),
        BokaMeraAdminiOS(2),
        BokaMeraAndroid(3),
        BokaMeraAdminAndroid(4);

        private final int value;
        VersionIdentifier(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class ApiVersionCompabilityQueryResponse
    {
        /**
        * The latest version number
        */
        public String CurrentVersion = null;
        /**
        * Your version number
        */
        public String YourVersion = null;
        /**
        * Any compatible error message
        */
        public String Message = null;
        /**
        * If your version is compatible with the current version
        */
        public Boolean Compatible = null;
        /**
        * If the changes are blocking for use and you need to upgrade to later version
        */
        public Boolean BlockingChanges = null;
        public ResponseStatus ResponseStatus = null;
        
        public String getCurrentVersion() { return CurrentVersion; }
        public ApiVersionCompabilityQueryResponse setCurrentVersion(String value) { this.CurrentVersion = value; return this; }
        public String getYourVersion() { return YourVersion; }
        public ApiVersionCompabilityQueryResponse setYourVersion(String value) { this.YourVersion = value; return this; }
        public String getMessage() { return Message; }
        public ApiVersionCompabilityQueryResponse setMessage(String value) { this.Message = value; return this; }
        public Boolean isCompatible() { return Compatible; }
        public ApiVersionCompabilityQueryResponse setCompatible(Boolean value) { this.Compatible = value; return this; }
        public Boolean isBlockingChanges() { return BlockingChanges; }
        public ApiVersionCompabilityQueryResponse setBlockingChanges(Boolean value) { this.BlockingChanges = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ApiVersionCompabilityQueryResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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>