Example 2: Retrieving and Displaying Project Information

This scenario covers how to fetch and present comprehensive project data. It’s useful for dashboards, reporting interfaces, and any environment where users or systems need at-a-glance updates on project status, associated files, and plan details.

Process:

  1. Get All Projects:

    • Endpoint: GET /projects

    • Action: Retrieve a list of all available projects for high-level overviews or dashboards.

  2. Get a Specific Project:

    • Endpoint: GET /projects/{id}

    • Action: Drill down into a particular project’s details, including metadata and IDs of related files and plans.

  3. Retrieve Plans and Files:

    • Endpoints:

      • GET /projects/{id}/plan to access the project’s plan data.

      • GET /projects/{id}/files to see all associated files.

    • Action: Provide users or other systems with visual references, floor plans, and relevant documentation.


Example Use Case:
An internal dashboard that allows managers to view a project’s current phase, review its floor plan, and confirm all required documents are on file before scheduling site visits.