Create or update needs

This endpoint allows to update or create the needs for a day.

PUT /api/v1/businesses/{businessId}/products/{productId}/needs/{yyyy-MM-dd}

In the request URL, the following parameters must be specified:

  • Business identifier (businessId).

  • Product or section identifier (productId).

  • Date for which the needs are created or updated in the yyyy-MM-dd format.

Below are the fields that make up the request body, some of which are mandatory for the request to be successful.

Mandatory fields are marked with an asterisk (*).

Request body

JSON Analysis 
[
  {
    "startMinuteDay": 0,
    "duration": 0,
    "location": "string",
    "value": 0
  }
]
Details

  • startMinuteDay*: start of the need in minutes from 00:00. For example, 600 for 10:00.

  • duration*: duration of the need period in minutes.

  • location*: identifier of the task linked to the need.

  • value: number of people needed to cover the need.

Request example

After analyzing the fields, an example of the request is shown:

PUT /api/v1/businesses/BUSINESSID/products/PRODUCTID/needs/2024-07-19
[
  {
    "startMinuteDay": 600,
    "duration": 60,
    "location": "03",
    "value": 5
  },
  {
    "startMinuteDay": 540,
    "duration": 120,
    "location": "06",
    "value": 2
  }
]

If all the request data is correct, the following needs will be created for the day 2024-07-19:

  • Task 03: 5 people at 10:00 with a duration of one hour.

  • Task 06: 2 people at 9:00 with a duration of two hours.

Considerations

The request takes the service time zone into account. Therefore, if the service is in UTC+2, the startMinuteDay field will consider that time zone.

If no value is specified, the need is deleted.

If an empty array ([]) is sent, all needs for that day are deleted.

If the task is not registered in the business task catalog or does not have an external identifier, the request will return a 404 Not Found error indicating Location not found.

If any of the mandatory fields are not sent, the request will return a 406 Not Acceptable error indicating which field is missing in the request body.

Useful links

What are needs?

What is the task catalog?