Skip to main content
Version: 1.x

User Manual

File Server​

Before you can exchange files you have to register a user. After that you can exchange files with the registered users.

The File Server uses SSL clientAuthentication, so the user must authenticate itself using an SSL certificate and the File Server must trust this certificate. The clientCertificate is registered with the user on the File Server and will be used to authenticate the user when up- or downloading a file.

See here for the OpenAPI Spec.

Manage Users​

You can manage users using the REST and SOAP UserService.

Exchange Files​

The File Server can exchange files with registered users using the REST and SOAP FileService.

File download​

  1. upload the file for the registered user userId to the File Server and receive the path to the download file
    Note: alternatively use the action uploadFileFromFs if you use a FileShare to transfer files
  2. Optional: download the external-data-reference for Grote Berichten file transfer
    Note: The external-data-reference contains the full download url to the file
  3. after the url is communicated, the user can download the file from the File Server using a client. The user can use a browser using the path and with its SSL keystore installed in the browser. The user can also use another HTTP download tool such as curl or wget or the File Client to download the file
  4. delete the file

File upload​

  1. the Client uploads the file to the File Server using a tus client
  2. after the url is communicated, download the file from path
    Note: alternatively use the action downloadFileFromFs if you use a FileShare to transfer files
  3. proces the file
  4. delete the file

Exchange Files via FileShare​

Files can also be exchanged with the File Server via a FileShare:

Manage Files​

You can manage files using the REST and SOAP FileService.

File Client​

See here for the OpenAPI Spec.

Exchange Files​

The File Client can exchange files using the download and upload REST and SOAP interfaces.

File download​

  1. create a DownloadTask to download url
  2. the File Client will start to download the file
  3. the application checks the status of the DownloadTask
  4. if the status == SUCCEEDED then download the File
  5. process the file
  6. delete the DownloadTask

File upload​

  1. create a UploadTask to upload NewFile to creationUrl
  2. the File Client will start to upload the file
  3. the application checks the status of the UploadTask
  4. if the status == SUCCEEDED then Optional: download the external-data-reference for Grote Berichten file transfer
    Note: The external-data-reference contains the full download url to the file
  5. delete the UploadTask

Exchange Files via FileShare​

Files can also be exchanged with the ClientServer via a FileShare:

Manage Files​

You can manage files using the REST and SOAP FileService.

Manage DownloadTasks​

You can manage DownloadTasks using the REST and SOAP DownloadService.

Manage UploadTasks​

You can manage UploadTasks using the REST and SOAP UploadService.