/{version}/reagentlots
The following operations are supported on this resource:
Displays a list of reagent lots stored in the system.
When submitting a GET request, you can use the following query parameters to filter the results.
For more information about using query parameters, please refer to the Filtering list resources section under REST General Concepts.
Parameters
name |
description |
type |
default |
start-index |
When working with large lists of results, displays the results from a set point. If omitted, the first page of results is returned.
|
query |
0 |
name |
Displays only reagent lots with names that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
kitname |
Displays only reagent lots whose associated reagent kits have names matching the given value. When filtering results, you can repeat this parameter.
|
query |
|
number |
Displays only reagent lots with numbers that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
Output Payload
element |
produceable content type(s) |
reagent-lots (XML)
|
|
description |
The system returns a response that includes a list of reagents lots and URI links. |
Creates a new reagent lot in the system.
When creating a reagent lot you must specify both lot number and expiry date unless the reagent lot status
is PENDING in which case those fields are not required.
If status is not specified, it will be set to PENDING by default.
An example of a <reagent-lot> is as follows:
<lot:reagent-lot xmlns:lot="http://genologics.com/ri/reagentlot">
<reagent-kit uri="http://localhost:8080/api/v2/reagentkits/101" name="Affy-3a"/>
<name>Affy-3a Batch #1</name>
<lot-number>5613281</lot-number>
<expiry-date>2014-05-01</expiry-date>
<storage-location>Cooler in room 204</storage-location>
<notes>Shipment Contained 2 kits.</notes>
<status>ACTIVE</status>
</lot:reagent-lot>
Input Payload
element |
consumeable content type(s) |
reagent-lot (XML)
|
|
description |
The information about the reagent lot you want to add to the system. |
Output Payload
element |
produceable content type(s) |
reagent-lot (XML)
|
|
description |
When the reagent lot is successfully created, the system returns an HTTP 201 (Created) code with
a response body that includes information about the new reagent lot. |