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.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Enums;

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 virtual VersionIdentifier Identifier { 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")]
        public virtual string Version { get; set; }
    }

    public partial class ApiVersionCompabilityQueryResponse
    {
        ///<summary>
        ///The latest version number
        ///</summary>
        public virtual string CurrentVersion { get; set; }
        ///<summary>
        ///Your version number
        ///</summary>
        public virtual string YourVersion { get; set; }
        ///<summary>
        ///Any compatible error message
        ///</summary>
        public virtual string Message { get; set; }
        ///<summary>
        ///If your version is compatible with the current version
        ///</summary>
        public virtual bool Compatible { get; set; }
        ///<summary>
        ///If the changes are blocking for use and you need to upgrade to later version
        ///</summary>
        public virtual bool BlockingChanges { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Enums
{
    public enum VersionIdentifier
    {
        BokaMeraiOS = 1,
        BokaMeraAdminiOS = 2,
        BokaMeraAndroid = 3,
        BokaMeraAdminAndroid = 4,
    }

}

C# ApiVersionCompabilityQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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"}}}