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.


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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}