LOloket
Partner

Create the partner for an employee

Activity name : <a href="https://developer.loket.nl/Activities/PostPartnerByEmployeeId" target="_blank">PostPartnerByEmployeeId</a>

Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.

Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.

Create the partner for an employee

post/v2/providers/employers/employees/{employeeId}/partners

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/{employeeId}/partners
  • 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)

startDatestring date nullable

startdate

endDatestring date nullable

end date

firstNamestring nullable

The first name, given name, forename or Christian name as part of a persons personal name.

lastNamestring

The last name, family name or surname as part of a persons personal name.

prefixstring nullable

The prefix to the last name

initialsstring nullable

The initials

dateOfBirthstring date

The date of birth

placeOfBirthstring nullable

The place of birth

dateOfDeathstring date nullable

The date of death

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "1995-05-21",
  "endDate": "1995-05-21",
  "firstName": "Susan",
  "lastName": "Bergen",
  "prefix": "van",
  "initials": "S.L.",
  "dateOfBirth": "1995-05-21",
  "placeOfBirth": "Amsterdam",
  "howToFormatLastName": {
    "key": 2,
    "value": "last name + last name partner"
  },
  "title": {
    "key": 2,
    "value": "e.g. Msc, PHD or Baron"
  },
  "gender": {
    "key": 2,
    "value": "female"
  },
  "waoClassification": {
    "key": 2,
    "value": "15 - 24"
  }
}

Response

Created

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",
    "startDate": "1995-05-21",
    "endDate": "1995-05-21",
    "firstName": "Susan",
    "lastName": "Bergen",
    "prefix": "van",
    "initials": "S.L.",
    "dateOfBirth": "1995-05-21",
    "placeOfBirth": "Amsterdam",
    "howToFormatLastName": {
      "key": 2,
      "value": "last name + last name partner"
    },
    "title": {
      "key": 2,
      "value": "e.g. Msc, PHD or Baron"
    },
    "gender": {
      "key": 2,
      "value": "female"
    },
    "waoClassification": {
      "key": 2,
      "value": "15 - 24"
    }
  }
}

Changes

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