GET V1 ems/studies

Gets a list of all of the currently active Studies available to the session user.

Request Information

Example Request

To get all of the currently active Studies available to the session user, make the following API call: GET /ems/studies

This endpoint requires the api-username and api-usertoken headers to be present. If these headers are not present, a 401 (Unauthorized) response will be returned.

Response Information

HTTP Status Codes

Status Code Meaning
200 (OK) The request has completed successfully. The active system studies will be contained in the response body.
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.
503 (ServiceUnavailable) EMS is currently unavailable.
Please try again later or contact a system administrator to ask when EMS will be back online.

Response Body Formats

application/json, text/json

Sample: 
[
  {
    "ID": 1,
    "Name": "Example Study 1",
    "ProjectID": 11,
    "ProjectName": "Example Project Name 1"
  },
  {
    "ID": 2,
    "Name": "Example Study 2",
    "ProjectID": 12,
    "ProjectName": "Example Project Name 2"
  },
  {
    "ID": 3,
    "Name": "Example Study 3",
    "ProjectID": 13,
    "ProjectName": "Example Project Name 3"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfStudy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.EMS.V1">
  <Study>
    <ID>1</ID>
    <Name>Example Study 1</Name>
    <ProjectID>11</ProjectID>
    <ProjectName>Example Project Name 1</ProjectName>
  </Study>
  <Study>
    <ID>2</ID>
    <Name>Example Study 2</Name>
    <ProjectID>12</ProjectID>
    <ProjectName>Example Project Name 2</ProjectName>
  </Study>
  <Study>
    <ID>3</ID>
    <Name>Example Study 3</Name>
    <ProjectID>13</ProjectID>
    <ProjectName>Example Project Name 3</ProjectName>
  </Study>
</ArrayOfStudy>