...
Veld | Type | Omschrijving | Voorbeeld |
---|---|---|---|
id | Guid | Uniek nummer voor dit event | 01759dc3-5d38-405b-9b1c-5a36b0373cc3 |
type | String | Type indicatie van het event | ao.order.statuschanged |
specversion | String | Versienummer van het response | 1.0 |
time | DateTimeOffset | Tijdstip waarop dit event plaats heeft gevonden | 2020-11-06T14:36:00.000+02:00 |
source | String | Locatie van de entiteit binnen AO die dit event getriggert heeft. | /tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa |
subject | String | Titel van het event | O-2387923 | T942855 |
datacontenttype | String | Content type van het data veld | application/json |
data | Object | Event (object) en Dictionary (met resourceReference als key). Het aantal teruggegeven resources is afhankelijk van de webhook instellingen. | Zie Event data en Resource data |
Event data
Per event type een voorbeeld en toelichting op het model. Ieder event heeft één vast veld: ResourceReference. Dit veld geeft een verwijzing naar de gedetailleerde weergave van de resource die dit event getriggert heeft. Voor OrderStatusChanged is dat dus de locatie van orderdetails.
...
Veld | Type | Omschrijving | Voorbeeld |
---|---|---|---|
type | String | Soort doorbelasting:
| Automatic |
customerOrderNumber | String | Inkoopopdrachtnummer | S1234235 |
debtor | RelationReference | Referentie naar debiteurinformatie | |
invoice | InvoiceReference | Referentie naar factuurinformatie | Zie InvoiceReference |
JobResource
Veld | Type | Omschrijving | Voorbeeld | ||
---|---|---|---|---|---|
type | String | Behandelingstype:
| BreakDownAssistance | ||
solution | String | Tekstuele toelichting van uitgevoerde werkzaamheden | Band gepropt en garage advies gegeven | ||
executeAfterDateTime | DateTimeOffset | Optioneel opgegeven tijdstip vanaf wanneer de opdracht uitgevoerd mag worden | 2020-11-06T14:36:00.000+02:00 | ||
executeBeforeDateTime | DateTimeOffset | Leadtijd, uiterste tijd om ter plaatse te zijn | 2020-11-06T14:36:00.000+02:00 | ||
jobAssignmentStatus | String | Huidige status van de behandeling
| Assigned | ||
result | String | Behandelingsresultaat. Dit is afhankelijk van het type behandeling. Pechhulp specifiek:
Berging specifiek:
Overige uitkomsten:
| BreakdownAssistanceOk | ||
locations | LocationReference[] | Lijst met locatiereferenties | |||
statusReports | StatusReports[] | Lijst met statusupdates | Zie StatusReport |
IMOrderDetailsResource
Veld | Type | Omschrijving | Voorbeeld | ||
---|---|---|---|---|---|
imNumber | String | IM-nummer | LCM20123456-IM | ||
llNumber | String | LL-nummer | LCM20123456-1 | ||
receivedAt | DateTimeOffset | Datum en tijd van waarop de melding is ontvangen | 2020-11-06T14:36:00.000+02:00 | ||
orders | OrderReference[] | Referenties naar opdrachtdossiers die zijn aangemaakt naar aanleiding van deze melding
| Zie OrderReference | ||
company | RelationReference | Referentie naar relatiedetails van de uitvoerende berger | |||
customer | RelationReference | Referentie naar relatiedetails van opdrachtgever | |||
description | String | Tekstuele toelichting | WIS aanrijdend;Pa:1 Vluchtstrook rechts lekke band verkeerszijde | ||
district | String | Rayon van deze melding | NH131 | ||
status | String | Voortgang van de melding
| Assigned |
...
Veld | Type | Omschrijving | Voorbeeld | ||
---|---|---|---|---|---|
type | String | Locatie type
| Address | ||
name | String | Naam van het adres | RGB+ Automatisering B.V. | ||
address | Address | Adresdetails
| Zie Address | ||
mainRoad | MainRoad | Hoofdwegdetails
| Zie MainRoad | ||
coordinates | Coordinates | Coordinaten van deze locatie | Zie Coordinates | ||
remark | String | Adres toelichting | Melden bij receptie |
...
Veld | Type | Omschrijving | Voorbeeld |
---|---|---|---|
orderNumber | String | Opdrachtnummer binnen AO | O-2387923 |
type | String | Opdrachttype
| ErrorParked |
company | RelationReference | Referentie naar relatiedetails van de uitvoerende berger | |
customer | RelationReference | Referentie naar relatiedetails van opdrachtgever | |
description | String | Toelichting op het dossier | SPOED, 5 min vtv bellen Lekke band, RA, Oorzaak onbekend. In de ondergrondse pkg Verwisselen ging niet. Reserveband is ook lek. |
externalReference | String | Kenmerk van de opdrachtgever | T123456 |
orderDateTime | DateTimeOffset | Moment van aanmaken van de opdracht | 2020-11-06T14:36:00.000+02:00 |
district | String | Rayon van de incidentlocatie | NH131 |
cause | String | Toelichting van de oorzaak | Lege accu |
status | String | Orderstatus
| Accepted |
isOnHold | Boolean | Wanneer het dossier op OnHold staat, is de berger tegen iets blokkerend aangelopen. | false |
...
Veld | Type | Omschrijving | Voorbeeld |
---|---|---|---|
licensePlate | String | Kenteken | AB123C |
chassisNumber | String | Chassisnummer | ZFFXA20A4J0076551 |
state | VehicleState | Staat van het voertuig | Zie VehicleState |
properties | VehicleProperties | Eigenschappen van het voertuig |
Overige data
Aanvullende data objecten waarmee resources verrijkt kunnen zijn.
...
Veld | Type | Omschrijving | Voorbeeld |
---|---|---|---|
latitude | Double | Breedtegraad (geodecimaalGeodecimaal) | 52.380205 |
longitude | Double | Lengtegraad (geodecimaalGeodecimaal) | 6.2958919 |
InvoiceReference
Veld | Type | Omschrijving | Voorbeeld |
---|---|---|---|
invoiceNumber | String | Factuurnummer | 202000001 |
resourceReference | String | Referentie naar de details van deze factuur | /tenants/1/invoices/fc9036ec-eb4a-496c-8c77-e972e3e800aa |
LocationReference
Veld | Type | Omschrijving | Voorbeeld |
---|---|---|---|
type | String | Rol van deze locatie:
| LoadLocation |
resourceReference | String | Referentie naar de details van deze locatie | /tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa/locations/0175acdc-6c37-4de1-a96c-f21a1a15d517 |
...