| 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. |
|---|
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 .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}