--- title: "Edit the details of an employee" method: PUT path: "/v2/providers/employers/employees/{employeeId}" tags: ["Employee"] --- # Edit the details of an employee `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 __Activity name :__ PutEmployeeByEmployeeId Edit the employee details
Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL ## Path parameters - `employeeId` string, uuid, required ## Headers - `Authorization` string, required - `Accept` string, required ## Request body - Employee20210329 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `employeeNumber` integer: The employee number to uniquely identify an employee within an employer - `personalDetails` PersonalDetails - `firstName` string, nullable: The first name, given name, forename or Christian name as part of a persons personal name. - `lastName` string: The last name, family name or surname as part of a persons personal name. - `prefix` string, nullable: The prefix to the last name - `initials` string: The initials - `lastNamePartner` string, nullable: The last name of the employee's partner. - `prefixPartner` string, nullable: The prefix to the last name of the employee's partner. - `formattedName` string: Formatted name of the employee based on the value of `howToFormatLastName` - `dateOfBirth` string, date: The date of birth - `placeOfBirth` string, nullable: The place of birth - `dateOfDeath` string, date, nullable: The date of death - `aowDate` string, date: The date when, according to Dutch law, the person has the right to a state pension. The value is generated by the system based on the date of birth. - `photo` string, url, nullable: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. - `howToFormatLastName` HowToFormatLastName: Indicates how the system will format the last name. - `key` integer - `value` string - `title` Title, nullable: The title to be used (if any). - `key` integer - `value` string - `nationality` object, nullable - `key` integer: The key for the nationality. Possible values can be aquired via the metadata endpoint - `value` string: Description of the nationality - `gender` Gender: The gender - `key` integer - `value` string - `civilStatus` object, nullable: The civil/marital status of the employee - `key` integer - `value` string - `contactInformation` ContactInformation20210329 - `phoneNumber` string, nullable: The phone number of the employee. - `mobilePhoneNumber` string, nullable: The mobile phone number of the employee. - `faxNumber` string, nullable: The fax number to contact this individual - `emailAddress` string, nullable: The e-mail address of the employee. - `businessPhoneNumber` string, nullable: The business phone number of the employee. - `businessMobilePhoneNumber` string, nullable: The business mobile phone number of the employee. - `businessEmailAddress` string, nullable: The business e-mail address of the employee. - `identityDocument` IdentityDocument, nullable - `typeOfDocument` object - `key` integer: The key for the type of document. Possible values can be aquired via the metadata endpoint - `value` string: Description of the type of document - `documentIdentification` string - `travel` Travel - `travelDistanceToWork` integer, nullable: The one way distance in meters the employee has to travel to work. - `travelDistanceToWorkInKm` number, double, nullable: The one way distance in kilometers the employee has to travel to work. - `address` Address3, nullable - `street` string: Streetname of the address - `city` string: City of the address - `houseNumber` integer: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication ('nadere aanduiding'). Possible values can be aquired via the metadata endpoint - `value` string: The description of the further indication ('nadere aanduiding'), the possible values are "WW" and "AB" - `postalCode` string: The postal code of the address, only nullable if country is not The Netherlands (NL). - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired via the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `deviatingPostalAddress` DeviatingPostalAddress2, nullable - `street` string, nullable: Streetname of the address - `city` string: City of the address - `houseNumber` integer: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired by the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string: The postal code of the address, only nullable if country is not The Netherlands (NL). - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired by the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `exclusionFromAbsenceStatus` boolean: Indicates whether the employee is excluded for any information of absence - `statusEmployeeSelfService` StatusEmployeeSelfService, nullable: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint - `key` integer - `value` string - `revokeEmployeeSelfServiceAccessOn` string, date, nullable: The date on which the Employee will be automatically blocked. ## Response `200` OK - object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour. - `version` Version - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available - `resourceVersion` string, date: The resource version of the object in the response - `messages` object[] - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages) - `description` string: Describes the message - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity - `code` integer: Identifying code for the message - `properties` string[]: An array that can contain additional information - `content` Employee20210329 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `employeeNumber` integer: The employee number to uniquely identify an employee within an employer - `personalDetails` PersonalDetails - `firstName` string, nullable: The first name, given name, forename or Christian name as part of a persons personal name. - `lastName` string: The last name, family name or surname as part of a persons personal name. - `prefix` string, nullable: The prefix to the last name - `initials` string: The initials - `lastNamePartner` string, nullable: The last name of the employee's partner. - `prefixPartner` string, nullable: The prefix to the last name of the employee's partner. - `formattedName` string: Formatted name of the employee based on the value of `howToFormatLastName` - `dateOfBirth` string, date: The date of birth - `placeOfBirth` string, nullable: The place of birth - `dateOfDeath` string, date, nullable: The date of death - `aowDate` string, date: The date when, according to Dutch law, the person has the right to a state pension. The value is generated by the system based on the date of birth. - `photo` string, url, nullable: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. - `howToFormatLastName` HowToFormatLastName: Indicates how the system will format the last name. - `key` integer - `value` string - `title` Title, nullable: The title to be used (if any). - `key` integer - `value` string - `nationality` object, nullable - `key` integer: The key for the nationality. Possible values can be aquired via the metadata endpoint - `value` string: Description of the nationality - `gender` Gender: The gender - `key` integer - `value` string - `civilStatus` object, nullable: The civil/marital status of the employee - `key` integer - `value` string - `contactInformation` ContactInformation20210329 - `phoneNumber` string, nullable: The phone number of the employee. - `mobilePhoneNumber` string, nullable: The mobile phone number of the employee. - `faxNumber` string, nullable: The fax number to contact this individual - `emailAddress` string, nullable: The e-mail address of the employee. - `businessPhoneNumber` string, nullable: The business phone number of the employee. - `businessMobilePhoneNumber` string, nullable: The business mobile phone number of the employee. - `businessEmailAddress` string, nullable: The business e-mail address of the employee. - `identityDocument` IdentityDocument, nullable - `typeOfDocument` object - `key` integer: The key for the type of document. Possible values can be aquired via the metadata endpoint - `value` string: Description of the type of document - `documentIdentification` string - `travel` Travel - `travelDistanceToWork` integer, nullable: The one way distance in meters the employee has to travel to work. - `travelDistanceToWorkInKm` number, double, nullable: The one way distance in kilometers the employee has to travel to work. - `address` Address3, nullable - `street` string: Streetname of the address - `city` string: City of the address - `houseNumber` integer: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication ('nadere aanduiding'). Possible values can be aquired via the metadata endpoint - `value` string: The description of the further indication ('nadere aanduiding'), the possible values are "WW" and "AB" - `postalCode` string: The postal code of the address, only nullable if country is not The Netherlands (NL). - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired via the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `deviatingPostalAddress` DeviatingPostalAddress2, nullable - `street` string, nullable: Streetname of the address - `city` string: City of the address - `houseNumber` integer: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired by the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string: The postal code of the address, only nullable if country is not The Netherlands (NL). - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired by the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `exclusionFromAbsenceStatus` boolean: Indicates whether the employee is excluded for any information of absence - `statusEmployeeSelfService` StatusEmployeeSelfService, nullable: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint - `key` integer - `value` string - `revokeEmployeeSelfServiceAccessOn` string, date, nullable: The date on which the Employee will be automatically blocked. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)