REST API

/{version}/reagentkits

The following operations are supported on this resource:

GET

Displays a list of reagent kits 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 kits with names that match the specified value. When filtering results, you can repeat this parameter. query

Output Payload

element produceable content type(s)
reagent-kits (XML)
  • application/xml
description
The system returns a response that includes a list of reagent kits and URI links.

POST

Creates a new reagent kit in the system.
When creating a new reagent kit, you must specify the name of the reagent kit you want to add. Unless your XML specifies a particular archived state, the system will automatically set archived to false.

An example of a <reagent-kit> is as follows:
<kit:reagent-kit xmlns:kit="http://genologics.com/ri/reagentkit">   <name>Affy-3a</name>   <supplier>Supplies Inc.</supplier>   <catalogue-number>1-AF-A</catalogue-number>   <website>www.suppliesinc.com</website>   <archived>false</archived> </kit:reagent-kit>

Input Payload

element consumeable content type(s)
reagent-kit (XML)
  • */*
  • application/xml
description
The information about the reagent kit you want to add to the system.

Output Payload

element produceable content type(s)
reagent-kit (XML)
  • application/xml
description
When the reagent kit is successfully created, the system returns an HTTP 201 (Created) code with a response body that includes information about the new reagent kit.

/{version}/reagentkits

Home

REST Endpoints

XML Data Elements

XML Data Types