REST API

Data: lot

  • Namespace: http://genologics.com/ri/reagentlot
  • XML Schema File: reagentlot.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 reagent-lot

The detailed representation of a Reagent Lot

Example XML

<?xml version="1.0" encoding="UTF-8"?> <lot:reagent-lot xmlns:lot="http://genologics.com/ri/reagentlot" uri="..." limsid="..."> <reagent-kit name="..." uri="..."> <!--content of type 'reagent-kit-link'--> </reagent-kit> <name> <!--content of type 'string'--> ... </name> <lot-number> <!--content of type 'string'--> ... </lot-number> <created-date> <!--content of type 'string'--> ... </created-date> <last-modified-date> <!--content of type 'string'--> ... </last-modified-date> <expiry-date> <!--content of type 'string'--> ... </expiry-date> <created-by uri="..."> <!--content of type 'researcher'--> </created-by> <last-modified-by uri="..."> <!--content of type 'researcher'--> </last-modified-by> <storage-location> <!--content of type 'string'--> ... </storage-location> <notes> <!--content of type 'string'--> ... </notes> <status> <!--content of type 'string'--> ... </status> <usage-count> <!--content of type 'long'--> ... </usage-count> </lot:reagent-lot>

Element reagent-lots

The representation of a list of Reagent Lots

Example XML

<?xml version="1.0" encoding="UTF-8"?> <lot:reagent-lots xmlns:lot="http://genologics.com/ri/reagentlot" uri="..."> <reagent-lot limsid="..." uri="..."> <!--content of type 'reagent-lot-link'--> </reagent-lot> <reagent-lot> <!--(another 'reagent-lot-link' type)--> </reagent-lot> <!--...more "reagent-lot" elements...--> <previous-page uri="..."> <!--content of type 'page'--> </previous-page> <next-page uri="..."> <!--content of type 'page'--> </next-page> </lot:reagent-lots>

Type reagent-kit-link

Reagent-Kit-Link is an element providing a URI linking to the detailed representation of a reagent kit.

Attributes

name type description
name string The name of the Reagent Kit.
Always returns with GET: Yes
uri anyURI The URI of the Reagent Kit.
Always returns with GET: Yes

Type reagent-lot

The detailed representation of a Reagent Lot

Attributes

name type description
uri anyURI The URI of the Reagent Lot.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
Updatable with PUT: No
Required for PUT: Yes
limsid string The limsid of the Reagent Lot.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
Updatable with PUT: No
Required for PUT: No

Child Elements

name (type) min/max
occurs
description
reagent-kit (reagent-kit-link) 0/1 The simple representation of the Reagent Kit this lot is associated with.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: Yes
Updatable with PUT: No
Required for PUT: No
name (string) 0/1 The name of the Reagent Lot.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: Yes
Updatable with PUT: Yes
Required for PUT: No
lot-number (string) 0/1 The lot number of the Reagent Lot.
Always returns with GET: NO
Creatable with POST: Yes
Required for POST: No
Updatable with PUT: Yes
Required for PUT: No
created-date (string) 0/1 The date the Reagent Lot was created.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
Updatable with PUT: No
Required for PUT: No
last-modified-date (string) 0/1 The date that the Reagent Lot was last modified.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
Updatable with PUT: No
Required for PUT: No
expiry-date (string) 0/1 The expiry date of the Reagent Lot.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: Yes
Updatable with PUT: Yes
Required for PUT: No
created-by (researcher) 0/1 The creator of the Reagent Lot.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
Updatable with PUT: No
Required for PUT: No
last-modified-by (researcher) 0/1 The user to last modify the reagent lot.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
Updatable with PUT: No
Required for PUT: No
storage-location (string) 0/1 The storage location of the Reagent Lot.
Always returns with GET: No
Creatable with POST: Yes
Required for POST: No
Updatable with PUT: Yes
Required for PUT: No
notes (string) 0/1 Additional notes on the Reagent Lot
Always returns with GET: No
Creatable with POST: Yes
Required for POST: No
Updatable with PUT: Yes
Required for PUT: No
status (string) 0/1 The status of the Reagent Lot. PENDING, ACTIVE, or ARCHIVED.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: No
Updatable with PUT: Yes
Required for PUT: No
usage-count (long) 0/1 The number of times this Reagent Lot has been used.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
Updatable with PUT: No
Required for PUT: No

Type reagent-lot-link

Reagent-lot-link is a child element type of Reagent Lots and provides a URI linking to the detailed representation of a Reagent Lot.

Attributes

name type description
limsid string The limsid of the Reagent Lot.
Always returns with GET: Yes
uri anyURI The URI of the Reagent Lot.
Always returns with GET: Yes

Type reagent-lots

The representation of a list of Reagent Lots

Attributes

name type description
uri anyURI The URI of the Reagent Lots.
Always returns with GET: Yes

Child Elements

name (type) min/max
occurs
description
reagent-lot (reagent-lot-link) 0/unbounded The list of Reagent Lots.
Always returns with GET: Yes
previous-page (page) 0/1 The previous page element, contains a link to the previous page of reagent lots, if required.
Always returns with GET: No
next-page (page) 0/1 The next page element, contains a link to the next page of reagent lots, if required.
Always returns with GET: No

Type researcher

Researcher is a child element of the reagent lot. It provides a URI linking to the detailed representation of the required researcher.

Attributes

name type description
uri anyURI The URI of the researcher.
Always returns with GET: Yes

Home

REST Endpoints

XML Data Elements

XML Data Types