Data: ri
- Namespace: http://genologics.com/ri
- XML Schema File: ri.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 index
- Type: index
Index is the entry point to a supported version of the API, providing a list of links to the available resources in that version in the system.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<ri:index xmlns:ri="http://genologics.com/ri">
<link rel="..." uri="...">
<!--content of type 'link'-->
</link>
<link>
<!--(another 'link' type)-->
</link>
<!--...more "link" elements...-->
</ri:index>
Element links
- Type: links
The representation of a list of resource links.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<ri:links xmlns:ri="http://genologics.com/ri">
<link rel="..." uri="...">
<!--content of type 'link'-->
</link>
<link>
<!--(another 'link' type)-->
</link>
<!--...more "link" elements...-->
</ri:links>
Type address
Address contains the related fields of a mailing address.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| street (string) | 0/1 | The street of the address. |
| city (string) | 0/1 | The city of the address. |
| state (string) | 0/1 | The state of the address. |
| country (string) | 0/1 | The country of the address. |
| postalCode (string) | 0/1 | The postal code of the address. |
| institution (string) | 0/1 | The institution of the address. |
| department (string) | 0/1 | The department of the address. |
Type container
Container is a child element of location and provides a URI linking to the detailed representation of the Container for the location.
Attributes
| name | type | description |
|---|---|---|
| limsid | string |
The LIMS ID of the Container.
Always returns with GET: Yes Creatable with POST: No Required for POST: No |
| uri | anyURI |
The URI of the Container.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes |
Type externalid
An external id is a reference to an identifier in an external system that contains additional information about a representation within the API.
External id is supported on representations that contain links back to external systems.
External id consists of two different URI type elements: id and URI. ID is the URI referencing the external system, and provides context and identification of the representation within that system. URI is the URI within the system, and provides a means of looking up the representation that the external id is associated with.
Attributes
| name | type | description |
|---|---|---|
| id | anyURI |
A URI identifying the representation in an external system.
The form of the id URI can be either a URL or URN, but it must include sufficient information to identify both the external system and the representation within that system. For a URN, the namespace identifier component should identify the external system. For a URL, the URL should be an absolute URL and not a relative URL to identify the external system. |
| uri | anyURI | The URI providing a link to the detailed representation that is identified by the external id. |
Type index
Index is the entry point to a supported version of the API, providing a list of links to the available resources in that version in the system.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| link (link) | 0/unbounded | Each link provides a URI to an available resource in the system. |
Type link
A link provides a URI linking to an additional resource.
The link is modelled on the link element defined by the Atom Syndication Format. The link includes a rel attribute that describes the URI of the link.
Attributes
| name | type | description |
|---|---|---|
| rel | string | The rel of the link. |
| uri | anyURI | The URI of the link. |
Type links
The representation of a list of resource links.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| link (link) | 0/unbounded | Link provides a URI linking to the detailed representation of a resource. |
Type location
Location provides a URI linking to the detailed representation of a Container along with the well location within that Container.
Location is used by representations to describe their location within a Container. For example Artifact and reagent use location to describe which Container they are located in.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| container (container) | 0/1 |
The Container for the location.
The Container element provides a URI linking to the detailed representation
of the Container for the location.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes |
| value (string) | 0/1 |
Placement of Artifact in the Container.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes |
Type page
The link to a page of additional content.
The system enforces a maximum number of elements when generating the list of links. When the size of the request result set is larger than the system maximum, the list represents a paged view of the overall results, and the previous-page and next-page elements provide URIs linking to the previous or next page of links in the overall results.
The previous-page and next-page elements are represented using the page type.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI linking to the page of additional content. |