Red Tractor API Website - Authorisation

Access information about the levels of access granted to the authenticated user

Get Authorisation Details GET

Gets details of the Red Tractor schemes and memberships that the current authenticated user has been granted access to, along with the authorised personas under which they may access each scheme.

Parameters

Response Parameters

Parameter	Description
EntityGUID String	The unique identifier for the authenticated user
EntityName String	The name of the authenticated user
EntityUsername String	The username of the authenticated user
EmailAddress String	The email address associated with the authenticated user
AllPersonas Enumeration	The overall list of personas under which the current user may access scheme data
Schemes List	The list of schemes to which the authenticated user has been granted accessOptional
SchemeGUID String	SchemeGUIDOptional
SchemeName String	SchemeNameOptional
Personas Enumeration	PersonasOptional
CertifierContact List	CertifierContactOptional
CertifierGUID String	CertifierGUIDOptional
CertifierName String	CertifierNameOptional
InspectorContact List	InspectorContactOptional
CertifierGUID String	CertifierGUIDOptional
CertifierName String	CertifierNameOptional
Memberships List	The list of memberships with which the authenticated user is associatedOptional
MembershipGUID String	MembershipGUIDOptional
SchemeName String	SchemeNameOptional
SchemeGUID String	SchemeGUIDOptional
CertifierName String	CertifierNameOptional
CertifierGUID String	CertifierGUIDOptional
MembershipNumber String	MembershipNumberOptional
MembershipStatus String	MembershipStatusOptional
Sites List	SitesOptional
SiteGUID String	SiteGUIDOptional
SiteName String	SiteNameOptional
SiteAddress String	SiteAddressOptional
SitePostcode String	SitePostcodeOptional
SiteHoldingNo String	SiteHoldingNoOptional
IsPrimary Boolean	IsPrimaryOptional
Buyers List	BuyersOptional
SiteGUID String	SiteGUIDOptional
SiteName String	SiteNameOptional
Suppliers List	SuppliersOptional
SiteGUID String	SiteGUIDOptional
SiteName String	SiteNameOptional
StartDate Date / Time	StartDateOptional
PasswordChangeRequired Boolean	Indicates that the user needs to change their password following a password reset
Corporates List	CorporatesOptional
CorporateGUID String	CorporateGUIDOptional
CorporateName String	CorporateNameOptional
Sectors List	SectorsOptional
SchemeGUID String	Optional
Farms List	FarmsOptional
MembershipGUID String	MembershipGUIDOptional

Enumerations

All Personas (Response)

Value	Description
Industry	Industry
Member	Member
Certifier	Certifier
Inspector	Inspector
Administrator	Administrator
Buyer	Buyer
Corporate	Corporate

Personas (Response)

Value	Description
Industry	Industry
Member	Member
Certifier	Certifier
Inspector	Inspector
Administrator	Administrator

XML

Example Request

GET https://api.redtractor.org.uk/v1/authorisation.eb 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="Authorisation">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="EntityGUID" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The unique identifier for the authenticated user</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="EntityName" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The name of the authenticated user</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="EntityUsername" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The username of the authenticated user</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="EmailAddress" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The email address associated with the authenticated user</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="AllPersonas">
          <xsd:annotation>
            <xsd:documentation>The overall list of personas under which the current user may access scheme data</xsd:documentation>
          </xsd:annotation>
          <xsd:simpleType>
            <xsd:list>
              <xsd:simpleType>
                <xsd:restriction base="xsd:string">
                  <xsd:enumeration value="Industry" />
                  <xsd:enumeration value="Member" />
                  <xsd:enumeration value="Certifier" />
                  <xsd:enumeration value="Inspector" />
                  <xsd:enumeration value="Administrator" />
                  <xsd:enumeration value="Buyer" />
                  <xsd:enumeration value="Corporate" />
                </xsd:restriction>
              </xsd:simpleType>
            </xsd:list>
          </xsd:simpleType>
        </xsd:element>
        <xsd:element name="Schemes" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>The list of schemes to which the authenticated user has been granted access</xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="SchemeGUID" minOccurs="0" type="xsd:string" />
                    <xsd:element name="SchemeName" minOccurs="0" type="xsd:string" />
                    <xsd:element name="Personas" minOccurs="0">
                      <xsd:simpleType>
                        <xsd:list>
                          <xsd:simpleType>
                            <xsd:restriction base="xsd:string">
                              <xsd:enumeration value="Industry" />
                              <xsd:enumeration value="Member" />
                              <xsd:enumeration value="Certifier" />
                              <xsd:enumeration value="Inspector" />
                              <xsd:enumeration value="Administrator" />
                            </xsd:restriction>
                          </xsd:simpleType>
                        </xsd:list>
                      </xsd:simpleType>
                    </xsd:element>
                    <xsd:element name="CertifierContact" minOccurs="0">
                      <xsd:complexType>
                        <xsd:sequence>
                          <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                            <xsd:complexType>
                              <xsd:sequence>
                                <xsd:element name="CertifierGUID" minOccurs="0" type="xsd:string" />
                                <xsd:element name="CertifierName" minOccurs="0" type="xsd:string" />
                              </xsd:sequence>
                            </xsd:complexType>
                          </xsd:element>
                        </xsd:sequence>
                      </xsd:complexType>
                    </xsd:element>
                    <xsd:element name="InspectorContact" minOccurs="0">
                      <xsd:complexType>
                        <xsd:sequence>
                          <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                            <xsd:complexType>
                              <xsd:sequence>
                                <xsd:element name="CertifierGUID" minOccurs="0" type="xsd:string" />
                                <xsd:element name="CertifierName" minOccurs="0" type="xsd:string" />
                              </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:element name="Memberships" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>The list of memberships with which the authenticated user is associated</xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="MembershipGUID" minOccurs="0" type="xsd:string" />
                    <xsd:element name="SchemeName" minOccurs="0" type="xsd:string" />
                    <xsd:element name="SchemeGUID" minOccurs="0" type="xsd:string" />
                    <xsd:element name="CertifierName" minOccurs="0" type="xsd:string" />
                    <xsd:element name="CertifierGUID" minOccurs="0" type="xsd:string" />
                    <xsd:element name="MembershipNumber" minOccurs="0" type="xsd:string" />
                    <xsd:element name="MembershipStatus" minOccurs="0" type="xsd:string" />
                    <xsd:element name="Sites" minOccurs="0">
                      <xsd:complexType>
                        <xsd:sequence>
                          <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                            <xsd:complexType>
                              <xsd:sequence>
                                <xsd:element name="SiteGUID" minOccurs="0" type="xsd:string" />
                                <xsd:element name="SiteName" minOccurs="0" type="xsd:string" />
                                <xsd:element name="SiteAddress" minOccurs="0" type="xsd:string" />
                                <xsd:element name="SitePostcode" minOccurs="0" type="xsd:string" />
                                <xsd:element name="SiteHoldingNo" minOccurs="0" type="xsd:string" />
                                <xsd:element name="IsPrimary" minOccurs="0" type="xsd:boolean" />
                              </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:element name="Buyers" minOccurs="0">
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="SiteGUID" minOccurs="0" type="xsd:string" />
                    <xsd:element name="SiteName" minOccurs="0" type="xsd:string" />
                    <xsd:element name="Suppliers" minOccurs="0">
                      <xsd:complexType>
                        <xsd:sequence>
                          <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                            <xsd:complexType>
                              <xsd:sequence>
                                <xsd:element name="SiteGUID" minOccurs="0" type="xsd:string" />
                                <xsd:element name="SiteName" minOccurs="0" type="xsd:string" />
                                <xsd:element name="StartDate" minOccurs="0" type="xsd:dateTime" />
                              </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:element name="PasswordChangeRequired" type="xsd:boolean">
          <xsd:annotation>
            <xsd:documentation>Indicates that the user needs to change their password following a password reset</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="Corporates" minOccurs="0">
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="CorporateGUID" minOccurs="0" type="xsd:string" />
                    <xsd:element name="CorporateName" minOccurs="0" type="xsd:string" />
                    <xsd:element name="Sectors" minOccurs="0">
                      <xsd:complexType>
                        <xsd:sequence>
                          <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                            <xsd:complexType>
                              <xsd:sequence>
                                <xsd:element name="SchemeGUID" minOccurs="0" type="xsd:string" />
                              </xsd:sequence>
                            </xsd:complexType>
                          </xsd:element>
                        </xsd:sequence>
                      </xsd:complexType>
                    </xsd:element>
                    <xsd:element name="Farms" minOccurs="0">
                      <xsd:complexType>
                        <xsd:sequence>
                          <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                            <xsd:complexType>
                              <xsd:sequence>
                                <xsd:element name="MembershipGUID" minOccurs="0" type="xsd:string" />
                              </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"?>
<Authorisation>
  <EntityGUID>xsd:string</EntityGUID>
  <EntityName>xsd:string</EntityName>
  <EntityUsername>xsd:string</EntityUsername>
  <EmailAddress>xsd:string</EmailAddress>
  <AllPersonas>xsd:string</AllPersonas>
  <Schemes>
    <Item>
      <SchemeGUID>xsd:string</SchemeGUID>
      <SchemeName>xsd:string</SchemeName>
      <Personas>xsd:string</Personas>
      <CertifierContact>
        <Item>
          <CertifierGUID>xsd:string</CertifierGUID>
          <CertifierName>xsd:string</CertifierName>
        </Item>...</CertifierContact>
      <InspectorContact>
        <Item>
          <CertifierGUID>xsd:string</CertifierGUID>
          <CertifierName>xsd:string</CertifierName>
        </Item>...</InspectorContact>
    </Item>...</Schemes>
  <Memberships>
    <Item>
      <MembershipGUID>xsd:string</MembershipGUID>
      <SchemeName>xsd:string</SchemeName>
      <SchemeGUID>xsd:string</SchemeGUID>
      <CertifierName>xsd:string</CertifierName>
      <CertifierGUID>xsd:string</CertifierGUID>
      <MembershipNumber>xsd:string</MembershipNumber>
      <MembershipStatus>xsd:string</MembershipStatus>
      <Sites>
        <Item>
          <SiteGUID>xsd:string</SiteGUID>
          <SiteName>xsd:string</SiteName>
          <SiteAddress>xsd:string</SiteAddress>
          <SitePostcode>xsd:string</SitePostcode>
          <SiteHoldingNo>xsd:string</SiteHoldingNo>
          <IsPrimary>xsd:boolean</IsPrimary>
        </Item>...</Sites>
    </Item>...</Memberships>
  <Buyers>
    <Item>
      <SiteGUID>xsd:string</SiteGUID>
      <SiteName>xsd:string</SiteName>
      <Suppliers>
        <Item>
          <SiteGUID>xsd:string</SiteGUID>
          <SiteName>xsd:string</SiteName>
          <StartDate>xsd:dateTime</StartDate>
        </Item>...</Suppliers>
    </Item>...</Buyers>
  <PasswordChangeRequired>xsd:boolean</PasswordChangeRequired>
  <Corporates>
    <Item>
      <CorporateGUID>xsd:string</CorporateGUID>
      <CorporateName>xsd:string</CorporateName>
      <Sectors>
        <Item>
          <SchemeGUID>xsd:string</SchemeGUID>
        </Item>...</Sectors>
      <Farms>
        <Item>
          <MembershipGUID>xsd:string</MembershipGUID>
        </Item>...</Farms>
    </Item>...</Corporates>
</Authorisation>

Download full schema

JSON

Example Request

GET https://api.redtractor.org.uk/v1/authorisation.eb HTTP/1.1
Accept: application/json

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{"EntityGUID":String,
  "EntityName":String,
  "EntityUsername":String,
  "EmailAddress":String,
  "AllPersonas":String,
  "Schemes":[{"SchemeGUID":String,
      "SchemeName":String,
      "Personas":String,
      "CertifierContact":[{"CertifierGUID":String,
          "CertifierName":String},
        ...],
      "InspectorContact":[{"CertifierGUID":String,
          "CertifierName":String},
        ...]},
    ...],
  "Memberships":[{"MembershipGUID":String,
      "SchemeName":String,
      "SchemeGUID":String,
      "CertifierName":String,
      "CertifierGUID":String,
      "MembershipNumber":String,
      "MembershipStatus":String,
      "Sites":[{"SiteGUID":String,
          "SiteName":String,
          "SiteAddress":String,
          "SitePostcode":String,
          "SiteHoldingNo":String,
          "IsPrimary":Boolean},
        ...]},
    ...],
  "Buyers":[{"SiteGUID":String,
      "SiteName":String,
      "Suppliers":[{"SiteGUID":String,
          "SiteName":String,
          "StartDate":String},
        ...]},
    ...],
  "PasswordChangeRequired":Boolean,
  "Corporates":[{"CorporateGUID":String,
      "CorporateName":String,
      "Sectors":[{"SchemeGUID":String},
        ...],
      "Farms":[{"MembershipGUID":String},
        ...]},
    ...]}

Get Authorisation Details GET

Parameters

Response Parameters

Enumerations

All Personas (Response)

Personas (Response)

XML

Example Request

Response Schema

Example Response

JSON

Example Request

Example Response

Test