GET V1 ems/wells?plateId={plateId}

Gets the Wells for a specific Plate. Each Well object returned contains a collection of factors (Formulations, Subtrates, Conditions and Condition Sets) applied to it.

Request Information

Parameters

Name Description Additional information
plateId 
The ID of the Plate to get Wells for.

Define this parameter in the request URI.

Example Request

To get the Wells for the Plate with ID 1234, make the following API call: GET /ems/wells?plateId=1234

Response Information

HTTP Status Codes

Status Code Meaning
200 (OK) The request has completed successfully. The Wells 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 Wells collection means that the Plate did not exist or it did not contain any Wells. An empty Factors collection for a Well means that the Well does not have any of that type of Factor associated with it. Within a Formulation or Substrate Factor, Amount may be null if there is no associated amount. Within a Formulation or Substrate Factor, Value may be null if there is no associated value.

Response Body Formats

application/json, text/json

Sample: 
[
  {
    "ID": 1234,
    "PlateID": 10001,
    "Row": 1,
    "Col": 1,
    "Barcode": "AB1111",
    "Valid": true,
    "ResultsAvailable": true,
    "Conditions": [
      {
        "Name": "Condition 1",
        "Value": "1.5",
        "Units": "s"
      }
    ],
    "ConditionSets": [
      {
        "Name": "Condition Set 1",
        "Setting": "Setting 1",
        "Conditions": [
          {
            "Name": "Condition 2",
            "Value": "A",
            "Units": "None"
          }
        ]
      }
    ],
    "Substrates": [
      {
        "Name": "Substrate List 1",
        "Value": "Substrate 1",
        "Type": "Substrate",
        "FlowId": 4000,
        "LotId": null,
        "LotNumber": null,
        "Barcode": null,
        "Units": "None",
        "Amount": null
      },
      {
        "Name": "Substrate List 2",
        "Value": "Substrate 2",
        "Type": "SubstrateLot",
        "FlowId": 5000,
        "LotId": 5001,
        "LotNumber": null,
        "Barcode": "ABCD1234",
        "Units": "None",
        "Amount": null
      }
    ],
    "Formulations": [
      {
        "Name": "Formulation List 1",
        "Value": "Formulation 1",
        "Type": "Formulation",
        "FlowId": 1000,
        "LotId": null,
        "LotNumber": null,
        "Barcode": null,
        "Units": "g",
        "Amount": 0.5
      },
      {
        "Name": "Formulation List 2",
        "Value": "Material 1",
        "Type": "Material",
        "FlowId": 2000,
        "LotId": null,
        "LotNumber": null,
        "Barcode": null,
        "Units": "g",
        "Amount": 1.0
      },
      {
        "Name": "Formulation List 3",
        "Value": "Material 2",
        "Type": "MaterialLot",
        "FlowId": 3000,
        "LotId": 3001,
        "LotNumber": "LOT1234",
        "Barcode": null,
        "Units": "g",
        "Amount": 1.5
      },
      {
        "Name": "Formulation List 4",
        "Value": "Adhoc Formulation",
        "Type": "Adhoc",
        "FlowId": null,
        "LotId": null,
        "LotNumber": null,
        "Barcode": null,
        "Units": "g",
        "Amount": 2.0
      }
    ]
  },
  {
    "ID": 5678,
    "PlateID": 10001,
    "Row": 1,
    "Col": 2,
    "Barcode": "",
    "Valid": true,
    "ResultsAvailable": false,
    "Conditions": [],
    "ConditionSets": [],
    "Substrates": [],
    "Formulations": []
  }
]

application/xml, text/xml

Sample: 
<ArrayOfWell xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.EMS.V1">
  <Well>
    <Barcode>AB1111</Barcode>
    <Col>1</Col>
    <ConditionSets>
      <WellConditionSet>
        <Conditions>
          <WellCondition>
            <Name>Condition 2</Name>
            <Units>None</Units>
            <Value>A</Value>
          </WellCondition>
        </Conditions>
        <Name>Condition Set 1</Name>
        <Setting>Setting 1</Setting>
      </WellConditionSet>
    </ConditionSets>
    <Conditions>
      <WellCondition>
        <Name>Condition 1</Name>
        <Units>s</Units>
        <Value>1.5</Value>
      </WellCondition>
    </Conditions>
    <Formulations>
      <WellFormulation>
        <Amount>0.5</Amount>
        <Barcode i:nil="true" />
        <FlowId>1000</FlowId>
        <LotId i:nil="true" />
        <LotNumber i:nil="true" />
        <Name>Formulation List 1</Name>
        <Type>Formulation</Type>
        <Units>g</Units>
        <Value>Formulation 1</Value>
      </WellFormulation>
      <WellFormulation>
        <Amount>1</Amount>
        <Barcode i:nil="true" />
        <FlowId>2000</FlowId>
        <LotId i:nil="true" />
        <LotNumber i:nil="true" />
        <Name>Formulation List 2</Name>
        <Type>Material</Type>
        <Units>g</Units>
        <Value>Material 1</Value>
      </WellFormulation>
      <WellFormulation>
        <Amount>1.5</Amount>
        <Barcode i:nil="true" />
        <FlowId>3000</FlowId>
        <LotId>3001</LotId>
        <LotNumber>LOT1234</LotNumber>
        <Name>Formulation List 3</Name>
        <Type>MaterialLot</Type>
        <Units>g</Units>
        <Value>Material 2</Value>
      </WellFormulation>
      <WellFormulation>
        <Amount>2</Amount>
        <Barcode i:nil="true" />
        <FlowId i:nil="true" />
        <LotId i:nil="true" />
        <LotNumber i:nil="true" />
        <Name>Formulation List 4</Name>
        <Type>Adhoc</Type>
        <Units>g</Units>
        <Value>Adhoc Formulation</Value>
      </WellFormulation>
    </Formulations>
    <ID>1234</ID>
    <PlateID>10001</PlateID>
    <ResultsAvailable>true</ResultsAvailable>
    <Row>1</Row>
    <Substrates>
      <WellSubstrate>
        <Amount i:nil="true" />
        <Barcode i:nil="true" />
        <FlowId>4000</FlowId>
        <LotId i:nil="true" />
        <LotNumber i:nil="true" />
        <Name>Substrate List 1</Name>
        <Type>Substrate</Type>
        <Units>None</Units>
        <Value>Substrate 1</Value>
      </WellSubstrate>
      <WellSubstrate>
        <Amount i:nil="true" />
        <Barcode>ABCD1234</Barcode>
        <FlowId>5000</FlowId>
        <LotId>5001</LotId>
        <LotNumber i:nil="true" />
        <Name>Substrate List 2</Name>
        <Type>SubstrateLot</Type>
        <Units>None</Units>
        <Value>Substrate 2</Value>
      </WellSubstrate>
    </Substrates>
    <Valid>true</Valid>
  </Well>
  <Well>
    <Barcode></Barcode>
    <Col>2</Col>
    <ConditionSets />
    <Conditions />
    <Formulations />
    <ID>5678</ID>
    <PlateID>10001</PlateID>
    <ResultsAvailable>false</ResultsAvailable>
    <Row>1</Row>
    <Substrates />
    <Valid>true</Valid>
  </Well>
</ArrayOfWell>