Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Latest commit

 

History

History
68 lines (38 loc) · 2.01 KB

submitting.md

File metadata and controls

68 lines (38 loc) · 2.01 KB
Raw

Submitting user data

Once a user’s data has been collected and the user has confirmed that the data is correct, urls representing the required output of the data and any uploaded files are sent to the submitter api

Submitting overview

Submission overview diagram

Default output

Send copy to user

In order to send a copy to the user, there must be an email address to send to:

  • If a value has been defined in the service configuration for emailInputNameUser, the value entered for the control with that name is used as the user’s email address
  • Otherwise, if a control named email exists, the value for that is used

Outputs

  • Email message
    • /api/submitter/email/user
  • PDF output
    • /api/submitter/pdf/default/:submissionId.pdf

Send application to service team via email

In order to send the data to the service team, there must be an email address to send to. This address is set through the Publisher as a config param SERVICE_OUTPUT_EMAIL

Outputs

  • Email message
    • /api/submitter/email/team
  • PDF output
    • /api/submitter/pdf/default/:submissionId.pdf
  • CSV (TODO)

JSON output

It is possible to get raw JSON for a submission from the Runner application. Currently this is forwarded onto adapters to make external API calls. In order to use this, two config params are required. SERVICE_OUTPUT_JSON_ENDPOINT and SERVICE_OUTPUT_JSON_KEY.

SERVICE_OUTPUT_JSON_ENDPOINT

The endpoint to which this JSON will be forwarded.

SERVICE_OUTPUT_JSON_KEY

A JWE key used for encrypting the data. This key has to be exactly 16 bytes.

  • API endpoint
    • /api/submitter/json/default/:submissionId.json

Output specification

In future, it will be possible to define alternative outputs

TODO: output specification

Form Builder Submitter

The Submitter is an app that provides an API and workers for dealing with a form’s submissions.

Submitter API