LOloket
Employment dossier

Upload a document to the employment dossier

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

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

Upload a document within the employee's employment dossier (werknemerdossier). Via Qwoater.

post/v2/providers/employers/employees/employments/{employmentId}/documents

Request

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

qwoaterDocumentIdstring uuid

Qwoater documentId

descriptionstring

The description defined by the submitter. Qwoater: Docfield 33 Omschrijving

categorystring metadata

The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType

yearinteger nullable

The year the document relates to. Qwoater: Docfield 86 Jaar

attributestring nullable

The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk

dateOfSubmissionstring date

The time at which document was submitted. Qwoater: CreationDate

dateOfAlertstring date nullable

The time at which document will alerted for cancellation. Qwoater: AlertDate

submittedBystring nullable

The name of the user that has submitted the document. Qwoater: Docfield 34 Gebruiker

filenamestring

The name of the file. Qwoater: Filename

qwoaterDirectUrlstring

The URL to this document in de Qwoater direct environment (different website/application)

filestring

base64 encoded document file.

sendEmailNotificationboolean nullable

Indicate whether to send an email to the employee.

Example request

{
  "description": "Copy of id card",
  "category": "Arbeidsovereenkomst",
  "year": 2017,
  "attribute": "VSP004",
  "dateOfSubmission": "2018-05-08",
  "dateOfAlert": "2018-05-08",
  "submittedBy": "Bowls, John",
  "filename": "BowlsJohn.pdf",
  "qwoaterDirectUrl": "https://direct.qwoater.nl/document/searchdocument/00000000-f100-4100-00fe-cd00e38223a3",
  "file": "YQ==",
  "sendEmailNotification": true
}

Response

Accepted

Changes

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