API Endpoint
https://api.xure.co/v1/lookup/ingredients

Get Ingredient Configuration GET

Gets ingredient data entry configuration information for a particular scheme. This retuns a list of the scopes defining the claims that can be flagged as required for ingredients.

Parameters

Request Parameters
ParameterDescription
SchemeIdentifier StringSchemeIdentifier
Response Parameters
ParameterDescription
AvailableClaims ListThe claims required for this ingredientOptional
GUID String
GUIDOptional
Name String
NameOptional
LogoURL String
LogoURLOptional

XML

Example Request 
GET https://api.xure.co/v1/lookup/ingredients.eb?SchemeIdentifier=String HTTP/1.1
Accept: text/xml
Response Schema 
<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="ScopeList">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="AvailableClaims" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>The claims required for this ingredient</xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="GUID" minOccurs="0" type="xsd:string" />
                    <xsd:element name="Name" minOccurs="0" type="xsd:string" />
                    <xsd:element name="LogoURL" minOccurs="0" type="xsd:string" />
                  </xsd:sequence>
                </xsd:complexType>
              </xsd:element>
            </xsd:sequence>
          </xsd:complexType>
        </xsd:element>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>
Example Response 
HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<ScopeList>
  <AvailableClaims>
    <Item>
      <GUID>xsd:string</GUID>
      <Name>xsd:string</Name>
      <LogoURL>xsd:string</LogoURL>
    </Item>...</AvailableClaims>
</ScopeList>

JSON

Example Request 
GET https://api.xure.co/v1/lookup/ingredients.eb?SchemeIdentifier=String HTTP/1.1
Accept: application/json
Example Response 
HTTP/1.1 200 OK
Content-Type: application/json

{"AvailableClaims":[{"GUID":String,
      "Name":String,
      "LogoURL":String},
    ...]}

Status Codes

Status and Error Codes
HTTP StatusError Code and Description
201
400

DataError:Category:InvalidSubschemeID
400

DataError:Ingredients:Category:InvalidCategoryReference
400

DataError:Ingredients:TotalComposition

Test