LOloket
Employee

Edit the details of an employee

Activity name : PutEmployeeByEmployeeId

Edit the employee details <br /> Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL

put/v2/providers/employers/employees/{employeeId}

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/{employeeId}
  • Auth
    none required

Path parameters

employeeIdstring uuid required

The unique identifier of the employee

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

employeeNumberinteger

The employee number to uniquely identify an employee within an employer

exclusionFromAbsenceStatusboolean

Indicates whether the employee is excluded for any information of absence

revokeEmployeeSelfServiceAccessOnstring date nullable

The date on which the Employee will be automatically blocked.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "employeeNumber": 156,
  "personalDetails": {
    "firstName": "Susan",
    "lastName": "Bergen",
    "prefix": "van",
    "initials": "S.L.",
    "lastNamePartner": "Wiel",
    "prefixPartner": "van de",
    "formattedName": "Wiel - van Bergen S.L. van de",
    "dateOfBirth": "1995-05-21",
    "placeOfBirth": "Amsterdam",
    "aowDate": "2062-08-21",
    "photo": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
    "howToFormatLastName": {
      "key": 2,
      "value": "last name + last name partner"
    },
    "title": {
      "key": 2,
      "value": "e.g. Msc, PHD or Baron"
    },
    "nationality": {
      "key": 2,
      "value": "Dutch"
    },
    "gender": {
      "key": 2,
      "value": "female"
    },
    "civilStatus": {
      "key": 2,
      "value": "Maried"
    }
  },
  "contactInformation": {
    "phoneNumber": "+31 13-1234567",
    "mobilePhoneNumber": "+31 6-1231456",
    "faxNumber": "+31 13-1234561",
    "emailAddress": "info@loket.nl",
    "businessPhoneNumber": "+31 13-1234567",
    "businessMobilePhoneNumber": "+31 6-1231456",
    "businessEmailAddress": "info@loket.nl"
  },
  "identityDocument": {
    "typeOfDocument": {
      "key": 2,
      "value": "Passport"
    },
    "documentIdentification": "CRE45553433"
  },
  "travel": {
    "travelDistanceToWork": 32,
    "travelDistanceToWorkInKm": 41.05
  },
  "address": {
    "street": "Voordijk",
    "city": "Leiden",
    "houseNumber": 12,
    "houseNumberAddition": "D",
    "furtherIndication": {
      "key": 1,
      "value": "WW"
    },
    "postalCode": "1234 AA",
    "location": "Fourth floor or building C",
    "country": {
      "key": 1,
      "value": "Netherlands",
      "isoCode": "NL"
    }
  },
  "deviatingPostalAddress": {
    "street": "Voordijk",
    "city": "Leiden",
    "houseNumber": 12,
    "houseNumberAddition": "D",
    "furtherIndication": {
      "key": 1,
      "value": "WW"
    },
    "postalCode": "1234 AA",
    "location": "Fourth floor or building C",
    "country": {
      "key": 1,
      "value": "Netherlands",
      "isoCode": "NL"
    }
  },
  "statusEmployeeSelfService": {
    "key": 2,
    "value": "Blocked"
  },
  "revokeEmployeeSelfServiceAccessOn": "2018-10-23"
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "employeeNumber": 156,
    "personalDetails": {
      "firstName": "Susan",
      "lastName": "Bergen",
      "prefix": "van",
      "initials": "S.L.",
      "lastNamePartner": "Wiel",
      "prefixPartner": "van de",
      "formattedName": "Wiel - van Bergen S.L. van de",
      "dateOfBirth": "1995-05-21",
      "placeOfBirth": "Amsterdam",
      "aowDate": "2062-08-21",
      "photo": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
      "howToFormatLastName": {
        "key": 2,
        "value": "last name + last name partner"
      },
      "title": {
        "key": 2,
        "value": "e.g. Msc, PHD or Baron"
      },
      "nationality": {
        "key": 2,
        "value": "Dutch"
      },
      "gender": {
        "key": 2,
        "value": "female"
      },
      "civilStatus": {
        "key": 2,
        "value": "Maried"
      }
    },
    "contactInformation": {
      "phoneNumber": "+31 13-1234567",
      "mobilePhoneNumber": "+31 6-1231456",
      "faxNumber": "+31 13-1234561",
      "emailAddress": "info@loket.nl",
      "businessPhoneNumber": "+31 13-1234567",
      "businessMobilePhoneNumber": "+31 6-1231456",
      "businessEmailAddress": "info@loket.nl"
    },
    "identityDocument": {
      "typeOfDocument": {
        "key": 2,
        "value": "Passport"
      },
      "documentIdentification": "CRE45553433"
    },
    "travel": {
      "travelDistanceToWork": 32,
      "travelDistanceToWorkInKm": 41.05
    },
    "address": {
      "street": "Voordijk",
      "city": "Leiden",
      "houseNumber": 12,
      "houseNumberAddition": "D",
      "furtherIndication": {
        "key": 1,
        "value": "WW"
      },
      "postalCode": "1234 AA",
      "location": "Fourth floor or building C",
      "country": {
        "key": 1,
        "value": "Netherlands",
        "isoCode": "NL"
      }
    },
    "deviatingPostalAddress": {
      "street": "Voordijk",
      "city": "Leiden",
      "houseNumber": 12,
      "houseNumberAddition": "D",
      "furtherIndication": {
        "key": 1,
        "value": "WW"
      },
      "postalCode": "1234 AA",
      "location": "Fourth floor or building C",
      "country": {
        "key": 1,
        "value": "Netherlands",
        "isoCode": "NL"
      }
    },
    "statusEmployeeSelfService": {
      "key": 2,
      "value": "Blocked"
    },
    "revokeEmployeeSelfServiceAccessOn": "2018-10-23"
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.