Endpoint: employees/add

Gewijzigd op Fri, 05 Apr 2024 om 09:14 PM

Omschrijving

Endpoint voegt nieuwe medewerker toe

Request

Method: POST

URL: employees/add/

Parameters: token

Example request: /api/v1/employees/add/

Request voorbeeld

{
    "firstName": "Jan",
    "lastName": "de Vries",
    "emailAddress": "jan@roosterplaats.test",
    "phoneNumber": "010-12345678",
    "externalReference": "abc123",
    "contractStatus": "active",
    "contractHours": 32.50,
    "contractType": "fixed",
    "contractStart": "22-01-2018",
    "contractEnd": "",
    "tariff": 22.75,
    "preference": "3",
    "notes": "example notes"
}

Response

Als response wordt het toegevoegde id van de medewerker geretourneerd inclusief de overige medewerker details.

{
    "[request]": {
        "path": "/api/v1/employees/add/",
        "arguments": [],
        "date": "2024-04-05 19:45:04",
        "status": "success"
    },
    "[employee]": {
        "id": 161481,
        "firstName": "Jan",
        "lastName": "de Vries",
        "emailAddress": "jan@roosterplaats.test",
        "phoneNumber": "010-12345678",
        "externalReference": "abc123",
        "contractStatus": "active",
        "contractHours": 32.50,
        "contractType": "fixed",
        "contractStart": "22-01-2018",
        "contractEnd": "",
        "tariff": 22.75,
        "preference": "3",
        "notes": "example notes"
    }
}

Veldbeschrijving

Veld	Beschrijving
id	Roosterplaats medewerker id
firstName *	Medewerker voornaam. Verplicht veld, mag niet leeg zijn.
lastName *	Medewerker achternaam. Verplicht veld, mag niet leeg zijn.
externalReference	Externe referentie van medewerker. (optioneel)
contractStatus	Bepaalt of de medewerker in actieve dienst is. Kan de waarde "actief" of "inactief" hebben. In geval niet meegestuurd dan default waarde 'actief' (optioneel)
contractHours *	Contracturen van een medewerker (max 2 decimalen). Verplicht veld.
contractType	Type contract. Kan de waarde "vast" of "flexibel" hebben. In geval niet meegestuurd dan default waarde 'vast'. (optioneel)
contractStart	Startdatum van het contract (optioneel)
contractEnd	Einddatum van het contract (optioneel)
tarrif *	Uurtarief van de medewerker (max 2 decimalen). Verplicht veld.
preference	Voorkeur voor inplannen van de medewerker bij automatisch plannen. In geval niet meegestuurd dan default waarde 3. (optioneel)
notes	Notities bij deze medewerker. (optioneel)