LOloket
Employee notes

Add a note for an employee

Activity name : <a href="https://developer.loket.nl/Activities/PostEmployeeNoteByEmployeeId" target="_blank">PostEmployeeNoteByEmployeeId</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.

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

Request

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

createdOnstring date-time

The date on which the note was created

subjectstring

subject of the note

notestring nullable

The note it self.

Note: This is a free text field so users can add htlm/script etc.

lastModifiedOnstring date-time

The date on which the note was last modified (this field has the same value as createdOn if no change was made afther creation).

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "createdOn": "2018-01-01",
  "createdBy": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "initials": "I",
    "prefix": "de",
    "lastName": "Jong",
    "formattedName": "Jong, I"
  },
  "accessibleBy": {
    "key": 1,
    "value": "Everyone"
  },
  "subject": "Remember to do xyz",
  "note": "Remember to do xyz",
  "lastModifiedOn": "2018-01-01",
  "lastModifiedBy": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "initials": "I",
    "prefix": "de",
    "lastName": "Jong",
    "formattedName": "Jong, I"
  }
}

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",
    "createdOn": "2018-01-01",
    "createdBy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "initials": "I",
      "prefix": "de",
      "lastName": "Jong",
      "formattedName": "Jong, I"
    },
    "accessibleBy": {
      "key": 1,
      "value": "Everyone"
    },
    "subject": "Remember to do xyz",
    "note": "Remember to do xyz",
    "lastModifiedOn": "2018-01-01",
    "lastModifiedBy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "initials": "I",
      "prefix": "de",
      "lastName": "Jong",
      "formattedName": "Jong, I"
    }
  }
}

Changes

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