Schakel JavaScript in om deze site te bekijken.

Made in EU
Loket.nl REST Forums

Loket.nl REST API Data Model

Navigatie: » Geen onderwerpen boven dit niveau «

CalendarAvailableHoursByEmployerId

List available hours per employment (for calendar)__Activity name :__ GetCalendarAvailableHoursByEmployerIdFor a calendar, this endpoint returns the availability of an employment expressed as a pattern for both odd and even weeks. Note that multiple patterns can be active in the time period that is requested using the query parameter `startDate` and `endDate`. While multiple patterns can be returned, on any date only one pattern is active. The patterns do not overlap.The available hours for a day are determined by the bi-weekly work pattern (as defined in the Working Hours resource) if such a work pattern is present for the employment. If no bi-weekly work pattern is present and the employment is NOT an on-call employment than the number of standard hours (either shiftHours or deviatingHoursPerWeek) is equally divided over the working days within each week (Monday through Friday).This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.

Catalog: LoketNlRest

Schema: Calendar

This is a read-only table function. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API.

Select loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/calendar/availablehours

Insert loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/calendar/availablehours

Update loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/calendar/availablehours

Delete loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/calendar/availablehours

Field Selection Method: NotRequired

Base Path: _embedded[*]

Select loket.nl (REST) API Operation: get /providers/employers/{employerId}/employees/employments/calendar/availablehours

Table Function Parameters

The following parameters can be used to control the behaviour of the table function CalendarAvailableHoursByEmployerId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

employerId

guid

☑

 

The unique identifier of the employer

endDate

datetime

☑

 

A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected.

startDate

datetime

☑

 

A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected.

 

Table Function Columns

The columns of the table function CalendarAvailableHoursByEmployerId are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

department_code

int32

 

☐

 

department_description

string

 

☐

 

department_key

guid

 

☐

The unique identifier of an object (GUID/UUID)

employee_formattedName

string(82)

 

☐

Formatted name of the employee based on the value of `howToFormatLastName`

employee_id

guid

 

☐

The unique identifier of an object (GUID/UUID)

employment_id

guid

 

☐

The unique identifier of an object (GUID/UUID)

 

13-05-2022 15:37 Version 22.1.40-BETA+3374

X

Belangrijke Informatie over Veiligheid en Gebruik

Beoogd gebruik en beperkingen: Deze software, ontwikkeld door Invantive, is ontworpen om een verscheidenheid aan zakelijke en informatietechnologische gegevensverwerkingsfuncties te ondersteunen, zoals boekhouding, financiële rapportage en verkooprapportage. Het is belangrijk om op te merken dat deze software niet is ontworpen, getest of goedgekeurd voor gebruik in omgevingen waar een storing of defect kan leiden tot levensbedreigende situaties, ernstige fysieke schade of milieuschade. Dit omvat, maar is niet beperkt tot:

  • Nucleaire faciliteiten: de software mag niet worden gebruikt voor operaties of functies die verband houden met de controle, het onderhoud of de werking van nucleaire faciliteiten.
  • Defensie en militaire toepassingen: deze software is niet geschikt voor gebruik in defensiegerelateerde toepassingen, inclusief maar niet beperkt tot wapenbeheer, militaire strategieplanning of andere aspecten van nationale defensie.
  • Luchtvaart: de software is niet bedoeld voor gebruik in de bediening, navigatie of communicatiesystemen van vliegtuigen of luchtverkeersleidingomgevingen.
  • Gezondheidszorg en medicijnproductie: deze software mag niet worden gebruikt voor de werking van medische apparaten, de analyse van patiëntgegevens voor kritieke gezondheidsbeslissingen, farmaceutische productie of medisch onderzoek waarbij een storing of defect de gezondheid van de patiënt kan beïnvloeden.
  • Verwerking van chemische en/of gevaarlijke stoffen: deze software is niet bedoeld voor het beheer, de controle of de operationele aspecten van chemische fabrieken of faciliteiten voor de verwerking van chemische en/of gevaarlijke stoffen. Elke storing in de software die in deze omgevingen wordt gebruikt kan leiden tot gevaarlijke chemische lozingen, explosies of milieurampen.
  • Transport- en verkeerscontrolesystemen: de software mag niet worden gebruikt voor de besturing, bediening of het beheer van transportsystemen, waaronder de besturing van spoorwegsignalen, metrosystemen of verkeerslichten. Storingen in dergelijke kritieke systemen kunnen tot ernstige ongelukken leiden en de openbare veiligheid in gevaar brengen.
  • Energienetwerk- en nutsbesturingssystemen: deze software is niet ontworpen voor de besturing of bediening van energienetwerksystemen, waaronder elektrische onderstations, besturingssystemen voor hernieuwbare energie of besturingssystemen van waternutsbedrijven. Het falen van software op deze gebieden kan leiden tot aanzienlijke stroomonderbrekingen, onderbrekingen in de watervoorziening of andere storingen in openbare voorzieningen, waardoor gemeenschappen in gevaar kunnen komen en grote schade kan worden aangericht.
  • Andere omgevingen met een hoog risico: alle andere kritieke infrastructuren en omgevingen waar een storing in de software kan leiden tot aanzienlijke schade aan personen of het milieu.

Gebruikersverantwoordelijkheid: gebruikers moeten ervoor zorgen dat ze het beoogde gebruik van de software begrijpen en de software niet gebruiken in een omgeving die buiten het beoogde doel valt. Het is de verantwoordelijkheid van de gebruiker om de geschiktheid van de software voor de beoogde toepassing te beoordelen, vooral in scenario's die een risico kunnen vormen voor leven, gezondheid en/of milieu.

Afwijzing van aansprakelijkheid: Invantive wijst elke verantwoordelijkheid af voor schade, letsel of wettelijke gevolgen die voortvloeien uit het gebruik of misbruik van deze software in verboden en/of onbedoelde toepassingen.
  
Disclaimer