GET v{version}/allergens

Details

Gets a list of supported allergen types that Procure Wizard supports.

https://api.procurewizard.com/v1.0/allergens

Request

URI Parameters

These are parameters passed as part of the URL in the request.

Name	Description	Type	Additional information
version	The API version parameter. The current version is 1.0.	string	None

Response

Response Description

A response object of AllergenArrayResponse

Name	Description	Type	Additional information
data	The responses data. This is an array of AllergenResponseData objects. If there are no items in the collection, then an empty array is returned.	Collection of AllergenResponseData	None
jsonApi	Implementation details of JSON:API.	Implementation	None
links	Related links.	Links	None
meta	A meta object used to include non-standard meta-information. Client meta data will be ignored by the server.	MetaData	None

Response Formats

Example responses of what the data might contain.

    
{
  "data": [
    {
      "id": "12345",
      "type": "allergen",
      "attributes": {
        "name": "Sample string 1",
        "shortName": "Sample string 2",
        "isPresent": "Yes"
      }
    },
    {
      "id": "12345",
      "type": "allergen",
      "attributes": {
        "name": "Sample string 1",
        "shortName": "Sample string 2",
        "isPresent": "Yes"
      }
    }
  ],
  "links": {
    "self": {
      "href": "http://example-url-1.com"
    },
    "related": {
      "href": "http://example-url-1.com"
    }
  },
  "meta": {
    "copyright": "© 2025 The Access Group"
  },
  "jsonApi": {
    "version": "1.0"
  }
}

    
<AllergenArrayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.Allergens">
  <JsonApi xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
    <d2p1:Version>1.0</d2p1:Version>
  </JsonApi>
  <Links xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
    <Related xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
      <d3p1:Href>http://example-url-1.com/</d3p1:Href>
      <d3p1:Meta i:nil="true" />
    </Related>
    <Self xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
      <d3p1:Href>http://example-url-1.com/</d3p1:Href>
      <d3p1:Meta i:nil="true" />
    </Self>
  </Links>
  <Meta xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
    <Copyright>© 2025 The Access Group</Copyright>
  </Meta>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.Allergens" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
    <d2p1:AllergenResponseData>
      <Id xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">12345</Id>
      <Attributes xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
        <d2p1:IsPresent>Yes</d2p1:IsPresent>
        <d2p1:Name>Sample string 1</d2p1:Name>
        <d2p1:ShortName>Sample string 2</d2p1:ShortName>
      </Attributes>
    </d2p1:AllergenResponseData>
    <d2p1:AllergenResponseData>
      <Id xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">12345</Id>
      <Attributes xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
        <d2p1:IsPresent>Yes</d2p1:IsPresent>
        <d2p1:Name>Sample string 1</d2p1:Name>
        <d2p1:ShortName>Sample string 2</d2p1:ShortName>
      </Attributes>
    </d2p1:AllergenResponseData>
  </Data>
</AllergenArrayResponse>

Back