LOloket
Workflow employment

Initiate the document request workflow for an employment

Activity name: <a href="https://developer.loket.nl/Activities/PostInitiateDocumentRequestWorkflowByEmploymentId" target="_blank">PostInitiateDocumentRequestWorkflowByEmploymentId</a><br> <br><br>Allows the user to trigger a workflow to request a document for an employment (by employmentId). The workflow may require the change to be approved.<br><br>Defaults : none<br>

post/v2/providers/employers/employees/employments/{employmentId}/workflow/InitiateDocumentRequest

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/workflow/InitiateDocumentRequest
  • Auth
    none required

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

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

documentTypestring

The documentType for now only exists out of one document type: employerStatement

commentstring nullable

An extra comment for the change request

Example request

{
  "documentType": "employerStatement",
  "comment": "Respond quickly please, I need the document by tomorrow afternoon."
}

Response

Accepted

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

Changes

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