Material order process
Die Aargauer Verwaltungsreformatoren
Material order process – getting started
Introducation
Material order process allows citizens to order different types of material, e.g. face masks, fire wood or other goods 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
Some municipalities offer different material and goods for their citizens to order online. As they login at the portal, they get an overview on the available goods, their previous orders, its status and so on. A new order will be sent over the portal through the Fit4Digital platform to the municipality 3rd party software, where it will be shown in an overview to work on for the municipality employees. The material will be prepared and as soon as it is ready to ship, the employees confirm the shipment in the system which will forward a status update of the order to the customers overview in the portal.
Sequence Diagram
Passing material order tasks to Fit4Digital
In this step, the Fit4Digital platforms creates an event mo.getarticles.
The event is created when the client kicksoff the process in the portal by requesting a list of the available items.
How to integrate for an mo.getarticles event
- Configure a webhook for the mo.getarticles event.
- Find the API to create,retrieve and update webhooks here.
- Available variable:
- ahvnumber (client provides thisnumber)
- When the system creates the event mo.getarticles, the above webhook will be executed.
- In the response to the webhook API call, the requested address data can be passed back.
- Find more information about the call back here.
- The response should be in thefollowing JSON format:
{
"id_subject": 0,
"firstname": "string",
"lastname": "string",
"street": "string",
"number": 0,
"addition": "string",
"zip": 0,
"city": "string",
"birthday": {
"date": "string",
"timezone_type": 0,
"timezone": "string"
},
"birth_city": "string",
"birth_canton": "string",
"civil_status": "string",
"nationality": "string",
"hometown_canton": "string",
"branch": "string",
"influx_date": { "date": "string",
"timezone_type": 0,
"timezone": "string" },
"influx_city": "string",
"influx_canton": "string"
}
Receiving new material order values
After the client submits the material order through the portal to the Fit4Digital platform, the Fit4Digital platform will confirm the order back to the portal by creating an event mo.ordersubmitted within the workflow.
To proceed with the order, the Fit4Digital platform creates an event mo.ordernew.
How to integrate for a mo.ordernew event:
- Configure a webhook for the mo.ordernew event.
- Find the API to create,retrieve and update webhooks here.
- Available variables:
- articles (collection of articles with the following fields):
- articleId
- number (number of articles ordered)
- user
- ahvnumber
- When the system creates the event mo.ordernew, the above webhook will be executed
- The response should be as following (two options):
- None, it is possible to not return content in the body
- a response with the order id and a status
- Find more information about the call back here.
