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

Lists all schemes that may be accessed within when finding or matching suppliers via the Live API

List Schemes GET

Retuns a list of all assurance schemes that may be searched within when finding or matching suppliers for a site through the Live API

Parameters

Request Parameters
ParameterDescription
SiteIdentifier StringThe unique identifier of the site to return available schemes for
Response Parameters
ParameterDescription
Schemes ListThe list of schemes available to search within
Name String
The name of the scheme
Identifier String
The unique identifier assigned to the scheme
MembershipNumberName String
The name the scheme uses to refer to the unique number or identifier assigned to each member
ExcludedIdentifiers List
The list of business identifiers that should be excluded as search options for membersOptional
IdentifierType String
The type of business identifier to exclude

XML

Example Request 
GET https://api.xure.co/v1/lookup/schemes.eb?SiteIdentifier=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="SchemeList">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="Schemes">
          <xsd:annotation>
            <xsd:documentation>The list of schemes available to search within</xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="Name" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>The name of the scheme</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="Identifier" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>The unique identifier assigned to the scheme</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="MembershipNumberName" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>The name the scheme uses to refer to the unique number or identifier assigned to each member</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="ExcludedIdentifiers" minOccurs="0">
                      <xsd:annotation>
                        <xsd:documentation>The list of business identifiers that should be excluded as search options for members</xsd:documentation>
                      </xsd:annotation>
                      <xsd:complexType>
                        <xsd:sequence>
                          <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                            <xsd:complexType>
                              <xsd:sequence>
                                <xsd:element name="IdentifierType" type="xsd:string">
                                  <xsd:annotation>
                                    <xsd:documentation>The type of business identifier to exclude</xsd:documentation>
                                  </xsd:annotation>
                                </xsd:element>
                              </xsd:sequence>
                            </xsd:complexType>
                          </xsd:element>
                        </xsd:sequence>
                      </xsd:complexType>
                    </xsd:element>
                  </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"?>
<SchemeList>
  <Schemes>
    <Item>
      <Name>xsd:string</Name>
      <Identifier>xsd:string</Identifier>
      <MembershipNumberName>xsd:string</MembershipNumberName>
      <ExcludedIdentifiers>
        <Item>
          <IdentifierType>xsd:string</IdentifierType>
        </Item>...</ExcludedIdentifiers>
    </Item>...</Schemes>
</SchemeList>

JSON

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

{"Schemes":[{"Name":String,
      "Identifier":String,
      "MembershipNumberName":String,
      "ExcludedIdentifiers":[{"IdentifierType":String},
        ...]},
    ...]}

Status Codes

Status and Error Codes
HTTP StatusError Code and Description
200
400

DataError:SiteIdentifier:InvalidIdentifier

Test

The unique identifier of the site to return available schemes for