REST API

Data: ver

  • Namespace: http://genologics.com/ri/version
  • XML Schema File: ver.xsd

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

The following types are members of this namespace:

Element version

Example XML

<?xml version="1.0" encoding="UTF-8"?> <ver:version xmlns:ver="http://genologics.com/ri/version" uri="..." major="..." minor="..." />

Element versions

Index is the base entry point to the API, providing a list of supported versions in the system.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <ver:versions xmlns:ver="http://genologics.com/ri/version"> <version uri="..." major="..." minor="..."> <!--content of type 'version'--> </version> <version> <!--(another 'version' type)--> </version> <!--...more "version" elements...--> </ver:versions>

Type version

Attributes

name type description
uri anyURI The URI of the version.
major string The major version of the version.

Major version indicates forward and backwards compatibility for API clients among minor versions within the major version.

minor string The minor version of the version.

Minor version indicates additional non-breaking changes to the version.

Type versions

Index is the base entry point to the API, providing a list of supported versions in the system.

Child Elements

name (type) min/max
occurs
description
version (version) 0/unbounded Each version provides a URI to a supported version in the system.

Home

REST Endpoints

XML Data Elements

XML Data Types