Antylogic
DemoApp login

399 operational guides

Docs sections
DocsReporting
Device

Load reports catalogue

Load the read-only catalogue of report sections and page links for Harbor Soho. The catalogue is scoped to the selected location and returns navigation metadata only, not report totals, charts, reservations, payments or staff metrics.

In this article

The reports catalogue tells an operator which reporting sections and pages are available for the current location. In the GB demo, this means Harbor Demo Group and the Harbor Soho location.

The visible Reports menu is the operator-facing equivalent of this catalogue. The current frontend menu is hard-coded, while `GET /api/app/{orgId}/{locationId}/reports/meta` exposes the same kind of read-only navigation metadata.

Before you start

  • The operator is signed in with a valid session for the protected `/api/app/` area.
  • Harbor Demo Group and Harbor Soho are selected so the app has both `orgId` and `locationId`.
  • The operator has location access with at least one accepted permission: `reports:view`, `tpv:view`, `tpv:use`, `catalog:view`, `reservation:view` or `staff:view`.
  • No date period, search term, filter, pagination control or request body is required.

Instructions

  1. 1.

    Open Harbor Soho

    Start in the Harbor Soho location context. The catalogue is location-scoped, so the app must know the organisation and location before it can resolve reporting navigation.

  2. 2.

    Open Reports

    Use the location side menu to enter Reports. This is the visible navigation equivalent of loading the reports catalogue for the selected location.

  3. 3.

    Review the sections

    Check the four catalogue sections: sales, catalogue, performance and employees. They contain links for billing, activity, fraud control, products, categories, restaurant, reservations and employee reporting pages.

  4. 4.

    Open a report page

    Choose a catalogue route such as `/reporting/performance/reservations`. The app shell keeps the current organisation and location context while opening the Reservations report.

  5. 5.

    Resolve access failures

    If Reports does not load, check the session, selected location and permissions first. Invalid methods, unknown `/reports` subroutes or missing access do not return the catalogue.

Validations and limits

  • The frontend requires non-empty `orgId` and `locationId`; otherwise it stops before the request with `orgId y locationId son requeridos`.
  • Only `GET /api/app/{orgId}/{locationId}/reports/meta` loads this catalogue.
  • The response is a `ReportsMenuSection[]`; each section has `key`, `label` and `pages`, and each page has `key`, `label` and `route`.
  • The catalogue is static in the backend and is not searched, sorted, filtered, paginated or localised per request.
  • Catalogue routes are relative paths such as `/reporting/performance/reservations`; the active location context is applied by the app shell.
  • Missing or invalid authentication returns `401 Unauthorized`; users without any accepted permission receive permission denied.

Expected result

The operator can see the reporting pages available for Harbor Soho and open a real report page without creating, editing or deleting business data.

Related articles