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.


export class ApiVersionCompabilityQueryResponse
{
    /** @description The latest version number */
    public CurrentVersion: string;
    /** @description Your version number */
    public YourVersion: string;
    /** @description Any compatible error message */
    public Message: string;
    /** @description If your version is compatible with the current version */
    public Compatible: boolean;
    /** @description If the changes are blocking for use and you need to upgrade to later version */
    public BlockingChanges: boolean;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<ApiVersionCompabilityQueryResponse>) { (Object as any).assign(this, init); }
}

export enum VersionIdentifier
{
    BokaMeraiOS = 1,
    BokaMeraAdminiOS = 2,
    BokaMeraAndroid = 3,
    BokaMeraAdminAndroid = 4,
}

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

    /** @description 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 Version: string;

    public constructor(init?: Partial<ApiVersionCompabilityQuery>) { (Object as any).assign(this, init); }
}

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