/util/schedule-availability

How does the endpoint schedule work?

1 Introduction
2 Parameters
3 Return body
- 3.1 Sample

Introduction

The endpoint /util/schedule-availability returns the availability from the planning screen

Parameters

The following parameters are available:

Parameter	Explanation

Parameter	Explanation
year	year, 1 year back, 1 year ahead counting from the current year
month	1 to 12
day	optional 1 to 31

Return body

Hour	Explanation

Hour	Explanation
number	Total capacity hours (*1) still available on this day

Note 1: capacity hours, this equals the total mechanic hours for this day minus all breaks, and appointments

Status value	Explanation

Status value	Explanation
unavailable	The specified date is NOT available for planning
blocked	The specified date is blocked for planning Can be saterday, sunday or blocked bij schedule
partial	The specified date is partial available for planning
available	The specified date is available for planning

Settings

Schedule status is configured in the Autoflex 10 interface: instellingen → Tab: planning → Tab: Algemeen

Sample

Sample return body information in JSON format:

{
  "data": [
    {
      "date": "01-03-2020",
      "hour": 0,
      "status": "unavailable"
    },
    {
      "date": "02-03-2020",
      "hour": 0,
      "status": "unavailable"
    },
    {
      "date": "03-03-2020",
      "hour": 0,
      "status": "blocked"
    },
    {
      "date": "04-03-2020",
      "hour": 0,
      "status": "unavailable"
    },
    {
      "date": "05-03-2020",
      "hour": 0,
      "status": "unavailable"
    }
...

Related articles