GET V1 fml/materials?materialName={materialName}

Gets the Material with the specified name. The Material details are retrieved from the Stain Lookup spreadsheet only.

Authentication

This endpoint requires the api-username and api-usertoken headers for authentication.

Request Information

Parameters

NameDescriptionAdditional information
materialName 
The Name of the Material to get. This is not case-sensitive.

Define this parameter in the request URI.

Example Request

To get the Material named Cotton, make the following API call: GET /fml/materials?materialName=Cotton

Response Information

HTTP Status Codes

Status CodeMeaning
200 (OK) The request has completed successfully. The Material will be contained in the response body (see below).
404 (Not Found) The Material with the specified Name could not be found. Ensure the Material Name has been correctly specified.

Response Body Formats

application/json, text/json

Sample: 
{
  "Name": "Cotton",
  "StainCode": "CN"
}

application/xml, text/xml

Sample: 
<Material xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.FReg.V1">
  <Name>Cotton</Name>
  <StainCode>CN</StainCode>
</Material>