API-endpoint employees/add: medewerker toevoegen

Met het endpoint employees/add voegt u een nieuwe medewerker toe aan Roosterplaats. Als antwoord krijgt u het id van de toegevoegde medewerker, met de overige gegevens van de medewerker.

Request

MethodePOST
URLemployees/add/
Parameterstoken

Voorbeeld: /api/v1/employees/add/

Voorbeeld van een verzoek

{
    "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"
}

Voorbeeld van een antwoord

{
    "[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

VeldBeschrijving
idRoosterplaats-id van de medewerker
firstName *Voornaam van de medewerker. Verplicht, mag niet leeg zijn.
lastName *Achternaam van de medewerker. Verplicht, mag niet leeg zijn.
externalReferenceExterne referentie van de medewerker (optioneel)
contractStatusOf de medewerker in actieve dienst is: "actief" of "inactief". Niet meegestuurd: "actief" (optioneel)
contractHours *Contracturen van de medewerker (maximaal 2 decimalen). Verplicht.
contractTypeSoort contract: "vast" of "flexibel". Niet meegestuurd: "vast" (optioneel)
contractStartStartdatum van het contract (optioneel)
contractEndEinddatum van het contract (optioneel)
tarrif *Uurtarief van de medewerker (maximaal 2 decimalen). Verplicht.
preferenceVoorkeur om de medewerker in te plannen bij automatisch plannen. Niet meegestuurd: 3 (optioneel)
notesNotities bij de medewerker (optioneel)

Velden met een * zijn verplicht.

Lees in Roosterplaats API hoe u de API inschakelt en hoe de antwoorden zijn opgebouwd.

Laatst bijgewerkt:

Meer artikelen in Endpoint-specificaties

Stel uw vraag via WhatsApp