As a contractor, I should be able to get all ordered materials for a project, so that I can understand how much of each was ordered and how much did it cost

[arafaysaleem]

Summary

As a contractor, I should be able to get all ordered materials for a project, so that I can understand how much of each was ordered and how much did it cost.

Acceptance Criteria

Scenario 1: Search for all possible materials orders in a project

GIVEN an contractor is requesting all possible materials in the desktop app
WHEN the app hits the /projects/:id/materials endpoint with a valid GET request, containing the path parameter:

• :id, the unique id of the project for which the materials are needed.

THEN the app should receive a status 200
AND in the response, the following information should be returned:

• headers
• list of materials

Sample Request/Sample Response
For e.g. If we request ordered materials for project id 1:

headers: {
    error: 0,
    message: "..."
}
body: [
    {
        order_id: 0,
        mat_id: 1,
        milestone_id: 0,
        project_id: 1,
        price: 1000,
        quantity_unit: "tonnes",
        quantity: 2
    },
    {
        order_id: 2,
        mat_id: 2,
        milestone_id: 0,
        project_id: 1,
        price: 1000,
        quantity_unit: "kg",
        quantity: 20
    },
    {
        order_id: 2,
        mat_id: 3,
        milestone_id: 0,
        project_id: 1,
        price: 1000,
        quantity_unit: "g",
        quantity: 200
    },
    ....
]

Scenario 2: Search for all possible materials orders in a project for a material

GIVEN an contractor is requesting all possible materials orders in the desktop app
WHEN the app hits the /projects/:id/materials endpoint with a valid GET request, containing:-"

• the path parameter:
  • :id, the unique id of the project for which the materials orders are needed.
• the query parameters:
  • mat_id="some_id", where some_id is the mat_id of that material**

THEN the app should receive a status 200
AND in the response, the following information should be returned:

• headers
• list of material orders having that project_id and mat_id

Sample Request/Sample Response
For project id 1 and query parameter mat_id=3:

headers: {
    error: 0,
    message: "..."
}
body: [
    {
        order_id: 0,
        mat_id: 3,
        milestone_id: 0,
        project_id: 1,
        price: 1000,
        quantity_unit: "tonnes",
        quantity: 2
    },
    {
        order_id: 2,
        mat_id: 3,
        milestone_id: 0,
        project_id: 1,
        price: 1000,
        quantity_unit: "kg",
        quantity: 20
    },
    {
        order_id: 2,
        mat_id: 3,
        milestone_id: 0,
        project_id: 1,
        price: 1000,
        quantity_unit: "g",
        quantity: 200
    },
    ....
]

Resources

• Development URL: {Here goes a URL to the feature on development API}
• Production URL: {Here goes a URL to the feature on production API}

Dev Notes

Testing Notes

{notes for QA, with examples if applicable}