Document order process
Die Aargauer Verwaltungsreformatoren
Document order process – getting started
Introducation
The document order process allows citizens to order all kind of personal and unpersonal documents available at their municipality.
Prerequisites
- Sign up for a developer account (If you already signed up, sign in here)
- Get subscription key from sign up account
- Register Application
- 3rd party software or webservice available to receive API calls
Business case description
To order personal documents, e.g. confirmation of residence, excerpt from the debt collection register or unpersonal documents as forms etc. the user logs in at the portal of its municipality where an overview of the available documents and forms, as well as an order history is shown.
An order can be submitted and depending on if it is a personal document or not, the document will be generated and returned right away from the system (mostly forms, unpersonal documents, etc.) or a new order task at the municipality side will be generated (documents with personal information of the user / sensitive data). The order task will be continued by an employee of the municipality who creates and generates the needed document out of the 3rd party software. Depending on the document the order will be returned by be the system or by post. The user will get a status update on its order over the system.
Sequence Diagram
Passing document order tasks to Fit4Digital
In this step, the Fit4Digital platforms creates an event do.getdocumentlist.
The event is created when the client kicks off the process in the portal by requesting a list of the available documents to order.
How to integrate for an do.getdocumentlist event
- Configure a webhook for the do.getdocumentlist event
- Find the API to create,retrieve and update webhooks here.
- Available variable:
- ahvnumber
- When the system creates the event do.getdocumentlist, the above webhook will be executed
- In the response to the webhook API call, the requested document list data can be passed back.
- Find more information about the call back here.
- The response should be in the following JSON format:
{
"types":[
{
"id":40,
"name":"Heimatausweis"
}, { "id":41,
"name":"Wohnsitzbescheinigung"
}
]
}
Receiving document order values
After the client submits the document order through the portal to the Fit4Digital platform, the Fit4Digital platform will confirm the order back to the portal by creating an event do.ordersubmitted within the workflow. To proceed with the order, the Fit4Digital platform creates an event do.ordernew
How to integrate a do.ordernew event
- Configure a webhook for the do.ordernew event
- Find the API to create,retrieve and update webhooks here.
- Available variables:
- id (the document ID)
- number (the number of documents ordered)
- ahvnumber
- When the system creates the event do.ordernew, the above webhook will be executed
- The response should be in the following JSON format (two options):
- None, it is possible to not return content in the body
- alternatively, it is possible to return the generated document. For body, see API
