Comparaison des versions

Version Ancienne version 11 Nouvelle version 12
Modifications effectuées par

Michel Frigon

Melissa Cote (Unlicensed)

Sauvegardée le

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

GET {url}/localtrac/locations/<location_uuid>/scheduleexceptions

This route will return the list of special opening hours (exceptions) where the opening hours of the location differ from the regular opening hours.

Request

Query

p

<int> Page to obtain

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Response (200) - Success

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body

Bloc de code
languagejson
{
  "2020-10-20": [
    {
      "start": <DateTime H:i>,
      "end": <DateTime H:i>
    }
  ],
  (...)
}

<day>

Each row represents a specific day where the opening hours differ from the regular opening hours. This row contains an array of intervals representing the opening hours of that day.

  • If null values is provided, this means the day is closed

    Bloc de code
    "2021-07-01": [ 
      {
        "start": null,
        "end": null
      }
   ],

  • If “start: HH:ii” and “end: HH:ii” is provided, this interval will be considered open. Multiple intervals can be provided.

    Bloc de code
    "2021-07-01": [
      {
        "start": "08:00",
        "end": "12:00"
      },
      {
        "start": "13:00",
        "end": "23:00"
      }
    ],

  • If you want to delete a schedule exception

    Bloc de code
    "2021-07-01": [],

POST {url}/localtrac/locations/<location_uuid>/scheduleexceptions

This route will add/update the schedule exception for each given day provided.

Request

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Content-Type

application/json

Body

Bloc de code
languagejson
{
  "2020-10-20": [
    {
      "start": <DateTime H:i>,
      "end": <DateTime H:i>
    }
  ],
  /** this will delete a schedule exception for this date **/
  "2020-12-31": [],
  (...)
}

Response (200) - Success

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body

Bloc de code
languagejson
{
  "message": "Schedules exceptions added"
}

Response (400) - Validation Error

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body

Bloc de code
languagejson
{
  "message": "Provided data contains error(s). See each entry in [errors]",
  "errors": {
    "2020-10-20.0.start": "Start hour cannot be higher than end hour"
  }
}

message

Always the same error message, indicating that an error occured during the validation process

errors

An associative array where the key represents the logical path to the data in error and the value represents the error found with the given data.

If a key contains “.” character, this means nested array. In the case of an array without keys, the logical number would be taken.

...