LOloket
Workflow employment

Check if a list of workflowId's for an employment have an attachment

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

Get a list of all declarationId's of declarations that have an attachment to it.

The attachment is stored in Qwoater, and thus on the background a call to Qwoater will be performed to check whether an attachment is available for a declaration.

If an attachment is available then a call may be performed to the attachment download endpoint to actually start downloading the attachment for this declaration.

get/qwoatermicroservice/providers/employers/employees/employments/{employmentId}/workflows/withattachment

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/qwoatermicroservice/providers/employers/employees/employments/{employmentId}/workflows/withattachment
  • Auth
    none required

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

Query parameters

workflowIdsstring uuid required

WorkflowIds for which the attachment is available. This parameter may be included multiple times to indicate multiple workflowIds.

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

Response

OK

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "workflowIds": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
    }
  ]
}

Changes

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