LOloket
Download request

Create a download request

Activity name: PostDownloadRequestByBearerToken<br> <br><br>Create a download request for an employment<br>

post/v2/providers/employers/users/downloadrequests

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/users/downloadrequests
  • Auth
    none required

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)

yearinteger

The year of the download request relates to

requestTimestring date-time

The time at which the download request was created by the user

processingFinishedTimestring date-time nullable

The time when the download become available.

expirationTimestring date-time nullable

The time at which the download will expire.

latestDownloadTimestring date-time nullable

The time of the most recent download.

filenamestring nullable

The name of the download file.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "year": 2017,
  "downloadRequestStatus": {
    "key": 2,
    "value": "Bestand aangemaakt"
  },
  "requestTime": "2018-05-08T15:16:49+02:00",
  "processingFinishedTime": "2018-05-09T15:16:49+02:00",
  "expirationTime": "2018-05-16T15:16:49+02:00",
  "latestDownloadTime": "2018-05-09T15:16:49+02:00",
  "filename": "WerkgeverDownload.rar"
}

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",
    "year": 2017,
    "downloadRequestStatus": {
      "key": 2,
      "value": "Bestand aangemaakt"
    },
    "requestTime": "2018-05-08T15:16:49+02:00",
    "processingFinishedTime": "2018-05-09T15:16:49+02:00",
    "expirationTime": "2018-05-16T15:16:49+02:00",
    "latestDownloadTime": "2018-05-09T15:16:49+02:00",
    "filename": "WerkgeverDownload.rar"
  }
}

Changes

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