GET V1 ems/protocols/{id}

Gets the Protocol with the specified id. The Protocol returned contains details on all the condition options.

Request Information

Parameters

Name Description Additional information
id 
The ID of the Protocol to get.

Define this parameter in the request URI.

Example Request

To get the Protocol with ID 1234, make the following API call: GET /ems/protocols/1234

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 details of the specified protocol 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.
404 (NotFound) The specified Protocol has not been found.
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: 
{
  "Category": "sample string 1",
  "Description": "sample string 2",
  "IsActive": true,
  "DefaultPlateDescription": "sample string 4",
  "ProtocolConditions": [
    {
      "Name": "sample string 1",
      "DefaultValue": "sample string 2",
      "DefaultUnit": "sample string 3",
      "Values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "Units": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    {
      "Name": "sample string 1",
      "DefaultValue": "sample string 2",
      "DefaultUnit": "sample string 3",
      "Values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "Units": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    {
      "Name": "sample string 1",
      "DefaultValue": "sample string 2",
      "DefaultUnit": "sample string 3",
      "Values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "Units": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    }
  ],
  "ID": 5,
  "Name": "sample string 6",
  "Type": "sample string 7"
}

application/xml, text/xml

Sample: 
<ProtocolDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.EMS.V1">
  <ID>5</ID>
  <Name>sample string 6</Name>
  <Type>sample string 7</Type>
  <Category>sample string 1</Category>
  <DefaultPlateDescription>sample string 4</DefaultPlateDescription>
  <Description>sample string 2</Description>
  <IsActive>true</IsActive>
  <ProtocolConditions>
    <ProtocolConditionDetails>
      <DefaultUnit>sample string 3</DefaultUnit>
      <DefaultValue>sample string 2</DefaultValue>
      <Name>sample string 1</Name>
      <Units xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Units>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Values>
    </ProtocolConditionDetails>
    <ProtocolConditionDetails>
      <DefaultUnit>sample string 3</DefaultUnit>
      <DefaultValue>sample string 2</DefaultValue>
      <Name>sample string 1</Name>
      <Units xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Units>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Values>
    </ProtocolConditionDetails>
    <ProtocolConditionDetails>
      <DefaultUnit>sample string 3</DefaultUnit>
      <DefaultValue>sample string 2</DefaultValue>
      <Name>sample string 1</Name>
      <Units xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Units>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Values>
    </ProtocolConditionDetails>
  </ProtocolConditions>
</ProtocolDetails>