GET v{version}/menus?fromMenuId={fromMenuId}

Details

Gets all menus for the current authenticated Purchaser starting from a specific menu. The menus returned in the response will only be a descendant of the a menu specified.

https://api.procurewizard.com/v1.0/menus?fromMenuId={fromMenuId}

Request

URI Parameters

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

Name	Description	Type	Additional information
fromMenuId	The menu ID.	integer	Required
version	The API version parameter. The current version is 1.0.	string	None

Response

Response Description

A response object of MenuArrayResponse

Name	Description	Type	Additional information
data	The responses data. This is an array of MenuResponseData objects. If there are no items in the collection, then an empty array is returned.	Collection of MenuResponseData	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": "menu",
      "attributes": {
        "name": "Sample string 1",
        "parentId": 2,
        "isActive": true,
        "description": "Sample string 4",
        "level": 5,
        "tags": [
          {
            "tagId": 1,
            "name": "Sample string 2"
          },
          {
            "tagId": 1,
            "name": "Sample string 2"
          }
        ],
        "hierarchy": "Grouping",
        "created": "2025-04-29T14:43:11.5416533+01:00",
        "updated": "2025-04-29T14:43:11.5416533+01:00"
      }
    },
    {
      "id": "12345",
      "type": "menu",
      "attributes": {
        "name": "Sample string 1",
        "parentId": 2,
        "isActive": true,
        "description": "Sample string 4",
        "level": 5,
        "tags": [
          {
            "tagId": 1,
            "name": "Sample string 2"
          },
          {
            "tagId": 1,
            "name": "Sample string 2"
          }
        ],
        "hierarchy": "Grouping",
        "created": "2025-04-29T14:43:11.5416533+01:00",
        "updated": "2025-04-29T14:43:11.5416533+01:00"
      }
    }
  ],
  "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"
  }
}

    
<MenuArrayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.MenusDishesRecipes.Menus">
  <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.MenusDishesRecipes.Menus" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
    <d2p1:MenuResponseData>
      <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:Created>2025-04-29T14:43:11.5416533+01:00</d2p1:Created>
        <d2p1:Description>Sample string 4</d2p1:Description>
        <d2p1:Hierarchy>Grouping</d2p1:Hierarchy>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:Level>5</d2p1:Level>
        <d2p1:Name>Sample string 1</d2p1:Name>
        <d2p1:ParentId>2</d2p1:ParentId>
        <d2p1:Tags xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
          <d5p1:Tag>
            <d5p1:Name>Sample string 2</d5p1:Name>
            <d5p1:TagId>1</d5p1:TagId>
          </d5p1:Tag>
          <d5p1:Tag>
            <d5p1:Name>Sample string 2</d5p1:Name>
            <d5p1:TagId>1</d5p1:TagId>
          </d5p1:Tag>
        </d2p1:Tags>
        <d2p1:Updated>2025-04-29T14:43:11.5416533+01:00</d2p1:Updated>
      </Attributes>
    </d2p1:MenuResponseData>
    <d2p1:MenuResponseData>
      <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:Created>2025-04-29T14:43:11.5416533+01:00</d2p1:Created>
        <d2p1:Description>Sample string 4</d2p1:Description>
        <d2p1:Hierarchy>Grouping</d2p1:Hierarchy>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:Level>5</d2p1:Level>
        <d2p1:Name>Sample string 1</d2p1:Name>
        <d2p1:ParentId>2</d2p1:ParentId>
        <d2p1:Tags xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
          <d5p1:Tag>
            <d5p1:Name>Sample string 2</d5p1:Name>
            <d5p1:TagId>1</d5p1:TagId>
          </d5p1:Tag>
          <d5p1:Tag>
            <d5p1:Name>Sample string 2</d5p1:Name>
            <d5p1:TagId>1</d5p1:TagId>
          </d5p1:Tag>
        </d2p1:Tags>
        <d2p1:Updated>2025-04-29T14:43:11.5416533+01:00</d2p1:Updated>
      </Attributes>
    </d2p1:MenuResponseData>
  </Data>
</MenuArrayResponse>

Back