Collaborator Service Requests Integration

Documentation of the integration with the Collaborator platform by Business Engineering

Components

Collaborator       Collaborator
On-premis -------- WebAPI --------- App Backend ----- App
    |                                                   |
Muni staff                                             End users

Collaborator

Data representation between Collaborator On-premis, Collaborator WebAPI, and the App Backend.

Field code	Field name (for documentation only)	Field description	Example value
F14	On-premis reference
F15	Status	Initial – When it comes in Registered – When an admin receives it Assigned – When the admin sent it to responsible official Completed – Once it is complete Finalised (This is more for on prem users and their administration purposes to give causes of complaint)
F18	Message	Updated automatically based on the chosen language and current status. Represents the mssage that is sent to the user via the chosen channel. Only available after a message has been set.
F20	Demarcation Code	Necessary to speak to the correct municipality's On-premis.	WC033

Service Request States

Collaborator Web API	App Backend API	User Interface
not here yet	Status: queued	Status: Submitted (grey)
On-Premis reference: missing Status: initial? Registered as well?	Status: created Reference number: null	Status: Submitted (grey) reference number: "Not available yet"
Status: registered On-premis reference: some number	Status: in_progress Reference number: some number	Satus: In progress (orange) Reference number: some number
	Status: completed	Status: Completed (green)