GET V1 ems/plates?experimentId={experimentId}

Gets the Plates for the Experiment with the specified ID.

Request Information

Parameters

Name Description Additional information
experimentId 
The ID of the Experiment to get Plates for.

Define this parameter in the request URI.

Example Request

To get the Plates for the Experiment with ID 1234, make the following API call: GET /ems/plates?experimentId=1234

Response Information

HTTP Status Codes

Status Code Meaning
200 (OK) The request has completed successfully. The Plates will be contained in the response body (see below).
401 (Unauthorized) The user has not been authorised due to the below reasons which will be displayed in the response content.
API Key is not found. Data received apiKey
Secret Key is wrong. Data received apiKey
Username not found. Data received apiKey
Received token not found in EMS issuer. Data received username, version
Lifetime validation failed. The token is expired. ValidTo (UTC): expiry, Current time (UTC): UTC DateTime
Token creation failed. Reason: The given username or password is wrong. For input: username, version
Please ensure that the client provides the api-username and api-usertoken headers.

Response Detail

An empty collection means that the experiment did not exist, it has been closed or it did not contain any Plates.

Response Body Formats

application/json, text/json

Sample: 
[
  {
    "ID": 1234,
    "Name": "Plate 1234",
    "ResultsAvailable": true,
    "Barcode": "AB12345678"
  },
  {
    "ID": 5678,
    "Name": "Plate 5678",
    "ResultsAvailable": false,
    "Barcode": ""
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPlate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.EMS.V1">
  <Plate>
    <Barcode>AB12345678</Barcode>
    <ID>1234</ID>
    <Name>Plate 1234</Name>
    <ResultsAvailable>true</ResultsAvailable>
  </Plate>
  <Plate>
    <Barcode></Barcode>
    <ID>5678</ID>
    <Name>Plate 5678</Name>
    <ResultsAvailable>false</ResultsAvailable>
  </Plate>
</ArrayOfPlate>