Locations

This section contains a detailed technical explanation of all the endpoints necessary to manage the information related to locations through the API.

Considerations

A location represents each of the tasks that can be performed within a service product. In the API, locations contain the following information:

  • color. Color configured in Orquest for the task.

  • description. Description of the task defined in Orquest.

  • name. Name of the task in Orquest.

  • shortName. Task abbreviation in Orquest.

  • requiredLevel. Skill level required to perform the task. Ranges from 0 (no training needed) to 3 (maximum training level) and must be previously configured in Orquest.

  • priority. Priority of task coverage. Ranges from 0 (low) to 5 (high) and must be previously configured in Orquest.

  • maxResources. Limit of people for the task.

  • type. Type of task, whether it is fixed, variable, or non-plannable (FIXED, VARIABLE, NON_PLANIFIABLE).

  • shouldAvoidOvercover. If this parameter is true, the task will not be overcovered.

  • system. Determines if the task was created by the system (true) or by the user (false).

  • category. Category of the task previously configured in Orquest.

  • product. External identifier of the product or section.

  • id. External identifier of the task.

  • active. If the task is active in the product (true) or not (false).

  • metadata. Any additional data that has been previously configured for the task in Orquest. The metadata structure must be previously configured.

  • zone. Physical place in the service (store, restaurant, etc.) where the location is carried out.