...
| Info |
|---|
Let op: Dit event gaat niet af voor transportopdrachten en opdrachten die toegewezen zijn aan een charter |
| Info |
|---|
Let op: Voor de ETA webhook kunnen kosten worden berekend. |
nl.assistanceonline.webhooks.consignmentnoteadded.v1
...
Gaat af op het moment dat de antwoorden op een vragenlijst worden opgeslagen.
nl.assistanceonline.resources.vehicle-pickedup-receipt.v1
Gaat af op het moment dat een voertuig wordt afgehaald.
Definities
Hieronder wordt kort toegelicht hoe responses van de webhooks eruit komen te zien. De basis bestaat uit en CloudEvent met daarin één Event en optioneel een aantal Resources.
...
Ieder event heeft drie vaste velden, de overige velden zijn afhankelijk van het type event.
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar het resource voor het opvragen van meer details | /tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa |
eventType | String | Event type | nl.assistanceonline.webhooks.orderstatuschanged.v1 |
resources | Dictionary<string, ResourceBase> | Dictionary met alle resources. (eventueel gefiltered door de instelling in de webhook) De key is de locatie in de API en resources refereren onderling via de key |
|
nl.assistanceonline.webhooks.orderstatuschanged.v1
...
| Code Block | ||
|---|---|---|
| ||
{
"orderNumber": "O-0000303",
"previousStatus": "Accepted",
"newStatus": "Assigned",
"resourceReference": "/tenants/1/orders/017a1434-117a-4d6f-8842-3fa81e0427d4",
"eventType": "nl.assistanceonline.webhooks.orderstatuschanged.v1",
"resources": {
"/tenants/1/orders/017a1434-117a-4d6f-8842-3fa81e0427d4": {
/* orderdata */
}
}
} |
Veld | Type | Omschrijving | Voorbeeld | ||
|---|---|---|---|---|---|
orderNumber | String | Ordernummer zoals bekend in AO
| O-2387923 | ||
previousStatus | String | Vorige opdrachtstatus (zie OrderStatusChanged voor events)
| New | ||
newStatus | String | Nieuwe opdrachtstatus | Accepted |
nl.assistanceonline.webhooks.jobetacalculated.v1
...
| Code Block | ||
|---|---|---|
| ||
{
"eta": "2021-11-01T13:41:10+01:00",
"startLocation": "/tenants/1/orders/017ccb9f-4659-40e9-accb-1f8fe215bb31/locations/017ccb9f-467b-4fde-b14f-463fe651d7de",
"destination": "/tenants/1/orders/017ccb9f-4659-40e9-accb-1f8fe215bb31/locations/017ccb9f-467b-4fde-b14f-463fe651d7de",
"timestamp": "2021-11-01T11:17:16.3991916+01:00",
"orderNumber": "O-0000090",
"imNumber": null,
"jobType": "BreakDownAssistance",
"resourceReference": "/tenants/1/jobs/017ccb9f-cf0b-4097-8ee4-78f9e48e0584",
"eventType": "nl.assistanceonline.webhooks.jobetacalculated.v1",
"resources": {
"/tenants/1/jobs/017ccb9f-cf0b-4097-8ee4-78f9e48e0584": {
/* jobdata */
}
}
} |
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
eta | DateTimeOffset | Het verwachte tijdstip dat de chauffeur ter plaatse is bij de incidentlocatie | 2021-11-01T13:41:10+01:00 |
startLocation | OrderLocationResourceReference | Referentie naar de incidentlocatie | |
destination | OrderLocationResourceReference | Referentie naar de eindbestemming van de behandeling. Dit kan bijvoorbeeld het depot zijn van de berger of het thuisadres van de berijder | |
timestamp | DateTimeOffset | Het tijdstip waarop de ETA berekend is | 2021-11-01T11:17:16.3991916+01:00 |
orderNumber | String | Opdrachtnummer binnen AO. Deze is leeg als het om een IM-opdracht gaat. | O-0000090 |
imNumber | String | IM-nummer. Deze is leeg als het om een normale opdracht gaat. | LCM20123456-IM |
jobType | String | Behandelingstype:
| BreakDownAssistance |
nl.assistanceonline.webhooks.consignmentnoteadded.v1
...
| Code Block | ||
|---|---|---|
| ||
{
"type": "load",
"downloadUrl": "url with sastoken",
"orderNumber": "O-0000357",
"generatedAt": "2021-11-16T13:02:13.2278412+01:00",
"resourceReference": "/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/consignment-notes/Load",
"eventType": "nl.assistanceonline.webhooks.consignmentnoteadded.v1",
"resources": {
"/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/consignment-notes/Load": {
// consignmentnote data
}
}
} |
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
type | String | Moment waarvoor de vrachtbrief is gegenereerd | Load of Unload |
downloadUrl | String | Url naar document incl sas-token. Deze is 7 dagen geldig. | |
orderNumber | String | Ordernumber binnen AO | O-0000090 |
generatedAt | DateTimeOffset | Tijdstip waarop vrachtbrief is gegenereerd |
nl.assistanceonline.webhooks.orderattachmentadded.v1
...
| Code Block | ||
|---|---|---|
| ||
{
"downloadUrl": "url met sastoken",
"name": "download (1).jfif",
"orderNumber": "O-0000357",
"description": "beschrijving bijlage",
"documentType": "IndemnityCertificate",
"resourceReference": "/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/attachments/e32ea561-2ee5-45f6-8056-d4cf5b6e2c10",
"eventType": "nl.assistanceonline.webhooks.orderattachmentadded.v1",
"resources": {
"/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/attachments/e32ea561-2ee5-45f6-8056-d4cf5b6e2c10": {
// order attachment data
}
}
} |
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
downloadUrl | String | Url naar document incl sas-token. Deze is 7 dagen geldig. | |
name | String | Naam van het bestand | |
orderNumber | String | Ordernumber binnen AO | O-0000090 |
description | String | Omschrijving | |
documentType | String | Type bijlage | IndemnityCertificate, MobilityDocument |
nl.assistanceonline.webhooks.invoicefinalized.v1
...
| Code Block | ||
|---|---|---|
| ||
{
"downloadUrl": "url met sastoken",
"invoiceNumber": 21000009,
"resourceReference": "/tenants/1/invoices/017d528c-e5d8-487a-90a4-dfbb22a31bac",
"eventType": "nl.assistanceonline.webhooks.invoicefinalized.v1",
"resources": {
"/tenants/1/invoices/017d528c-e5d8-487a-90a4-dfbb22a31bac": {
// invoice data
}
}
} |
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
downloadUrl | String | Url naar de pdf van de factuur incl sas-token. Deze is 7 dagen geldig. | |
invoiceNumber | Long | Factuurnummer | 21000009 |
nl.assistanceonline.webhooks.orderchecklistsaved.v1
...
| Code Block | ||
|---|---|---|
| ||
{
"orderNumber": "O-0000151",
"answeredAt": "2022-03-03T13:31:16.956+01:00",
"externalIdentifier": null,
"isExternal": false,
"resourceReference": "/tenants/1/orders/017f1beb-407a-4def-b707-1ce5dea9b2ed/order-checklists/017f1beb-4455-47eb-9772-f97f12f815a2",
"eventType": "nl.assistanceonline.webhooks.orderchecklistsaved.v1",
"resources": {
"/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/consignment-notes/Load": {
// consignmentnote data
}
}
} |
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
orderNumber | String | Ordernumber binnen AO | O-0000151 |
answeredAt | DateTimeOffset | Tijdstip waarop de vragenlijst is beantwoord | |
externalIdentifier | String | Referentie van de opdrachtgever naar de vragenlijst | |
isExternal | Boolean | Indicatie of de vragenlijst extern (door opdrachtgever meegegeven aan de opdracht) of intern (door berger ingericht) is |
nl.assistanceonline.resources.vehicle-pickedup-receipt.v1
json voorbeeld bericht
| Code Block | ||
|---|---|---|
| ||
{
"downloadUrl": "url met sastoken",
"orderNumber": "O-0000162",
"generatedAt": "2024-06-26T05:22:14.009Z",
"resourceReference": "/tenants/1/orders/01904ee7-7ee9-4ec6-8b6c-35dbbc698778/vehicle-pickedup-receipt",
"eventType": "nl.assistanceonline.resources.vehicle-pickedup-receipt.v1",
"resources": {
"/tenants/1/orders/01904ee7-7ee9-4ec6-8b6c-35dbbc698778/vehicle-pickedup-receipt": {
"downloadUrl": "url met sastoken",
"order": "/tenants/1/orders/01904ee7-7ee9-4ec6-8b6c-35dbbc698778",
"resourceType": "nl.assistanceonline.resources.vehicle-pickedup-receipt.v1",
"resourceReference": "/tenants/1/orders/01904ee7-7ee9-4ec6-8b6c-35dbbc698778/vehicle-pickedup-receipt"
}
}
} |
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
downloadUrl | String | Url naar de pdf van de factuur incl sas-token. Deze is 7 dagen geldig. | |
orderNumber | String | Ordernumber binnen AO | O-0000151 |
createdAt | DateTimeOffset | Tijdstip waarop het afhaalbewijs is aangemaakt. |
Resource data
Iedere resource bevat twee standaard velden:
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar het resource voor het opvragen van meer details | /tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa |
resourceType | String | Typering van de resource. B.v. Order, Job, Location, etc. | Order |
ConsignmentNoteResource
...
Veld
...
Type
...
Omschrijving
...
Voorbeeld
...
type
...
String
...
Moment waarvoor de vrachtbrief is gegenereerd
...
Load of Unload
...
downloadUrl
...
String
...
Url naar document incl sas-token. Deze is 7 dagen geldig.
...
Order
...
OrderReference
...
Referentie naar de OrderResource
...
Zie OrderReference
...
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
type | String | Moment waarvoor de vrachtbrief is gegenereerd | Load of Unload |
downloadUrl | String | Url naar document incl sas-token. Deze is 7 dagen geldig. | |
Order | OrderReference | Referentie naar de OrderResource | Zie OrderReference |
JobBillingResource
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
type | String | Soort doorbelasting:
| Automatic |
customerOrderNumber | String | Inkoopopdrachtnummer | S1234235 |
debtor | RelationReference | Referentie naar debiteurinformatie | |
invoice | InvoiceReference | Referentie naar factuurinformatie (InvoiceResource wordt nog niet meegestuurd) | Zie InvoiceReference |
JobResource
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
type | String |
Soort doorbelasting:
Automatic (Behorende bij een behandeling)
Manual (Aanvullende facturatie, handmatig toegevoegd)
VehicleStorage (Stallingsbehandeling)
StandByShift (Standbydienst)
Automatic
customerOrderNumber
String
Inkoopopdrachtnummer
S1234235
debtor
RelationReference
Referentie naar debiteurinformatie
invoice
InvoiceReference
Referentie naar factuurinformatie (InvoiceResource wordt nog niet meegestuurd)
Zie InvoiceReference
JobResource
...
Veld
...
Type
...
Omschrijving
...
Voorbeeld
...
type
...
String
...
Behandelingstype:
BreakDownAssistance (Pechhulp)
PlannableTransport (Planbaar transport)
VehicleStorage (Stalling)
Salvage (Berging)
ErrorParked (Foutparkeerder)
Cleaning (Reiniging)
Im (IM melding)
TransportAfterFirstService (Doortransport)
LostCargo (Afgevallen lading)
NonPlannableTransport (Niet planbaar transport
Seizure (Inbeslagname)
Security (Beveiliging)
AbandonedVehicle (Achtergelaten voertuig)
StandBy (Standby dienst)
...
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
...
result
...
String
...
Behandelingsresultaat. Dit is afhankelijk van het type behandeling.
Pechhulp specifiek:
BreakdownAssistanceOk (Pechhulp geslaagd)
BreakdownAssistanceNotRepairedTransportToDepot (Pechhulp naar depot)
BreakdownAssistanceNotRepairedTransportToDestination (Pechhulp naar eindbestemming)
BreakdownAssistanceTransportWithoutRepairAttempt (Transport zonder reparatiepoging)
Berging specifiek:
OwnStrength (Eigen kracht verder)
SalvageDepot (Berging naar depot)
SalvageFinalDestination (Berging naar eindbestemming)
Overige uitkomsten:
EmptyRide (Loze rit)
JobResultOk (Behandeling afgerond)
SecondSalvor (Tweede inzet gevraagd)
...
BreakdownAssistanceOk
...
locations
...
OrderLocationReference[]
...
Lijst met locatiereferenties
...
...
statusReports
...
StatusReports[]
...
Lijst met statusupdates
...
Zie StatusReport
...
order
...
OrderReference
...
Referentie naar de opdracht, kan leeg zijn
...
Zie OrderReference
...
imOrder
...
ImOrderReference
...
Referentie naar de imOpdracht, kan leeg zijn
...
Zie ImOrderReference
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
| Info |
|---|
Let op: Bij nieuwe IM-melding is het mogelijk dat er nog geen opdrachten zijn aangemaakt. |
Zie OrderReference
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 |
result | String | Behandelingsresultaat. Dit is afhankelijk van het type behandeling. Pechhulp specifiek:
Berging specifiek:
Overige uitkomsten:
| BreakdownAssistanceOk |
locations | OrderLocationReference[] | Lijst met locatiereferenties | |
statusReports | StatusReports[] | Lijst met statusupdates | Zie StatusReport |
order | OrderReference | Referentie naar de opdracht, kan leeg zijn | Zie OrderReference |
imOrder | ImOrderReference | Referentie naar de imOpdracht, kan leeg zijn | Zie ImOrderReference |
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 de 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 | ||
incidentLocation | OrderLocationReference | Locatie van het incident |
InvoiceResource
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
debtor | RelationReference | Referentie naar relatiedetails van de |
debiteur |
company | RelationReference | Referentie naar relatiedetails van de |
|---|
uitvoerende berger |
Veld
Type
Omschrijving
Voorbeeld
debtor
RelationReference
Referentie naar relatiedetails van de debiteur
company
RelationReference
Referentie naar relatiedetails van de uitvoerende berger
orders
List<OrderReference>
Lijst met referentie naar de opdrachten die in deze factuur zitten
Zie OrderReference
invoiceDate
DateTimeOffset
De factuurdatum
2020-11-06T14:36:00.000+02:00
paymentTerm
Integer
Betalingstermijn waarbinnen de factuur betaald moet zijn
30
period
Integer
Boekingsperiode: De maand waarin de factuur is geboekt
11
fiscalYear
Integer
Boekingsperiode: Het jaar waarin de factuur is geboekt
2021
invoiceNumber
Long
Factuurnummer
21000009
debtorNumber
String
Debiteurnummer
2142
downloadUrl
String
orders |
|---|
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
Accepted (Geaccepteerd)
Assigned (Toegewezen)
Enroute (Onderweg)
Arrived (Ter plaatse)
Empty (Loze rit)
| Info |
|---|
Let op: Een IM-melding is klaar als de berger ter plaatse is en gaat dan verder in het gerelateerde opdrachtdossier of als de rit loosgemeld is. |
Assigned
incidentLocation
OrderLocationReference
Locatie van het incident
InvoiceResource
List<OrderReference> | Lijst met referentie naar de opdrachten die in deze factuur zitten | Zie OrderReference | |
invoiceDate | DateTimeOffset | De factuurdatum | 2020-11-06T14:36:00.000+02:00 |
|---|---|---|---|
paymentTerm | Integer | Betalingstermijn waarbinnen de factuur betaald moet zijn | 30 |
period | Integer | Boekingsperiode: De maand waarin de factuur is geboekt | 11 |
fiscalYear | Integer | Boekingsperiode: Het jaar waarin de factuur is geboekt | 2021 |
invoiceNumber | Long | Factuurnummer | 21000009 |
debtorNumber | String | Debiteurnummer | 2142 |
downloadUrl | String | Url naar de pdf van de factuur incl sas-token. Deze is 7 dagen geldig. | |
totalAmount | decimal | Totaal bedrag van de factuur, incl. BTW | |
totalAmountExVat | decimal | Totaal bedrag van de factuur. excl. BTW |
LocationResource
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 |
OrderAttachment
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
downloadUrl | String | Url naar document incl sas-token. Deze is 7 dagen geldig. |
name |
|---|
String |
Totaal bedrag van de factuur, incl. BTW
totalAmountExVat
decimal
Totaal bedrag van de factuur. excl. BTW
LocationResource
...
Veld
...
Type
...
Omschrijving
...
Voorbeeld
...
type
...
String
...
Locatie type
MainRoad (A en N-wegen)
Address (Straatadres)
...
Address
...
name
...
String
...
Naam van het adres
...
RGB+ Automatisering B.V.
...
address
...
Address
...
Adresdetails
| Info |
|---|
Let op: Dit veld is alleen gevuld als type ‘Address’ is |
...
Zie Address
...
mainRoad
...
MainRoad
...
Hoofdwegdetails
| Info |
|---|
Let op: Dit veld is alleen gevuld als type ‘MainRoad’ is |
...
Zie MainRoad
...
coordinates
...
Coordinates
...
Coordinaten van deze locatie
...
Zie Coordinates
...
remark
...
String
...
Adres toelichting
...
Melden bij receptie
...
Naam van het bestand | |||
description | String | Omschrijving | |
|---|---|---|---|
documentType | String | Type bijlage
| IndemnityCertificate, MobilityDocument |
order | OrderReference | Verwijzing naar de opdracht waaraan het bestand is toegevoegd | Zie OrderReference |
isInternal | Boolean | Indicatie om aan te geven of een bestand alleen voor intern gebruik is. | |
fileSize | Long | Aantal bytes van het bestand | |
mimeType | String | Mimetype van het bestand | |
Timestamp | DateTimeOffset | Tijdstip waarop bestand is toegevoegd. |
OrderChecklist
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
order | OrderReference | Verwijzing naar de opdracht waaraan de vragenlijst is toegevoegd | Zie OrderReference |
answeredAt | DateTimeOffset | Tijdstip waarop de vragenlijst is beantwoord. | |
externalIdentifier | String | Referentie van de opdrachtgever naar de vragenlijst | |
isExternal | String | Indicatie of de vragenlijst extern (door opdrachtgever meegegeven aan de opdracht) of intern (door berger ingericht) is | |
name | String | De naam van de vragenlijst | |
processStep | String | Voor wie de vragenlijst bedoeld is:
| |
checklistItems | ChecklistItem | De vragen en antwoorden op de vragenlijst | Zie ChecklistItem |
OrderResource
Veld | Type | Omschrijving | Voorbeeld |
|---|
orderNumber | String |
|---|
Url naar document incl sas-token. Deze is 7 dagen geldig.
name
String
Naam van het bestand
order
OrderReference
Verwijzing naar de opdracht waaraan het bestand is toegevoegd
Zie OrderReference
isInternal
Boolean
Indicatie om aan te geven of een bestand alleen voor intern gebruik is.
fileSize
Long
Aantal bytes van het bestand
mimeType
String
Mimetype van het bestand
Timestamp
DateTimeOffset
Tijdstip waarop bestand is toegevoegd.
OrderChecklist
...
Veld
...
Type
...
Omschrijving
...
Voorbeeld
...
order
...
OrderReference
...
Verwijzing naar de opdracht waaraan de vragenlijst is toegevoegd
...
Zie OrderReference
...
answeredAt
...
DateTimeOffset
...
Tijdstip waarop de vragenlijst is beantwoord.
...
externalIdentifier
...
String
...
Referentie van de opdrachtgever naar de vragenlijst
...
isExternal
...
String
...
Indicatie of de vragenlijst extern (door opdrachtgever meegegeven aan de opdracht) of intern (door berger ingericht) is
...
name
...
String
...
De naam van de vragenlijst
...
processStep
...
String
...
Voor wie de vragenlijst bedoeld is:
OrderIntake
DriverApp
...
checklistItems
...
ChecklistItem
...
De vragen en antwoorden op de vragenlijst
...
Zie ChecklistItem
OrderResource
...
Veld
...
Type
...
Omschrijving
...
Voorbeeld
...
orderNumber
...
String
...
Opdrachtnummer binnen AO
...
O-2387923
...
type
...
String
...
Opdrachttype
Breakdown (Pechhulp)
PlannableTransportation (Planbaar transport)
Damage (Schade / Berging)
ErrorParked (Foutgeparkeerd)
Seizure (Inbeslagname)
LostCargo (Afgevallen lading)
AbandonedVehicle (Achtergelaten voertuig)
Cleaning (Reiniging)
NonPlannableTransportation (Niet planbaar transport)
VehicleStorage (Stalling)
Security (Beveiliging)
StandBy (Standbydienst)
...
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
New (Nieuw)
Accepted (Geaccepteerd)
Assigned (Toegewezen)
Arrived (Ter plaatse)
Loaded (Opgeladen)
InterimLocation (Op tussen bestemming)
Plannable (Planbaar voor doortransport, tweede behandeling aangemaakt)
TransportAfterFirstService (Doortransport toegewezen)
Destination (Eindbestemming, auto gelost op eindbestemming en opdracht gereed)
Invoiced (Gefactureerd)
Empty (Loze rit)
Canceled (Vervallen)
Credited (Gecrediteerd)
...
Accepted
...
isOnHold
...
Boolean
...
Wanneer het dossier op OnHold staat, is de berger tegen iets blokkerend aangelopen.
...
false
...
incidentLocation
...
OrderLocationReference
...
Locatie van het incident
...
...
interimLocations
...
OrderLocationReference[]
...
Lijst met eventuele tussenbestemmingen
...
...
destinationLocation
...
OrderLocationReference[]
...
Eindbestemming van het voertuig dat is betrokken bij deze opdracht
...
...
imOrder
...
ImOrderReference
...
Referentie naar de imOpdracht, kan leeg zijn
...
Zie ImOrderReference
...
jobs
...
JobReference[]
...
Referentie naar de behandelingen bij deze opdracht
...
Zie JobReference
...
jobBillings
...
JobBillingRefernce
...
Referentie naar de jobbillings bij deze opdracht
...
...
towingVehiclePosition
...
TowingVehiclePositionReference
...
Referentie naar de positie van het bergingsvoertuig
| Info |
|---|
Let op: Bergingsvoertuigposities worden alleen meegestuurd als de opdracht de status onderweg of ter plaatse heeft en als er een (recente)positie bekend is. |
...
Zie TowingVehiclePositionReference
...
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 | ||
incidentLocation | OrderLocationReference | Locatie van het incident | |||
interimLocations | OrderLocationReference[] | Lijst met eventuele tussenbestemmingen | |||
destinationLocation | OrderLocationReference[] | Eindbestemming van het voertuig dat is betrokken bij deze opdracht | |||
imOrder | ImOrderReference | Referentie naar de imOpdracht, kan leeg zijn | Zie ImOrderReference | ||
jobs | JobReference[] | Referentie naar de behandelingen bij deze opdracht | Zie JobReference | ||
jobBillings | JobBillingRefernce | Referentie naar de jobbillings bij deze opdracht | |||
towingVehiclePosition | TowingVehiclePositionReference | Referentie naar de positie van het bergingsvoertuig
|
RelationResource
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
name | String | Relatienaam | RGB+ Automatisering B.V. |
debtorNumber | String | Debiteurnummer, zoals deze relatie bekend staat in de boekhouding van de berger | 1000032 |
TowingVehiclePositionResource
| Info |
|---|
Let op: Bergingsvoertuigposities worden alleen meegestuurd als de opdracht de status onderweg of ter plaatse heeft en als er een (recente)positie bekend is. |
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
coordinates | Coordinates | Laatste positie van het voertuig | Zie Coordinates |
updatedAt | DateTimeOffset | Tijdstip van laatste gps signaal | 2020-11-06T14:36:00.000+02:00 |
VehicleResource
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 |
DriverResource
Veld | Type | Omschrijving | Voorbeeld |
|---|
Salutation | String |
|---|
Relatienaam
RGB+ Automatisering B.V.
debtorNumber
String
Debiteurnummer, zoals deze relatie bekend staat in de boekhouding van de berger
1000032
TowingVehiclePositionResource
| Info |
|---|
Let op: Bergingsvoertuigposities worden alleen meegestuurd als de opdracht de status onderweg of ter plaatse heeft en als er een (recente)positie bekend is. |
...
Veld
...
Type
...
Omschrijving
...
Voorbeeld
...
coordinates
...
Coordinates
...
Laatste positie van het voertuig
...
Zie Coordinates
...
updatedAt
...
DateTimeOffset
...
Tijdstip van laatste gps signaal
...
2020-11-06T14:36:00.000+02:00
VehicleResource
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
Aanhef | De heer | ||
Initials | String | Initialen | R.G. |
|---|---|---|---|
Prefixes | String | Voorvoegsels | van der |
Name | String | Naam | Janssens |
String | Email adres | r.janssens@gmail.com | |
Phone | String | Telefoonnummer | 0524365987 |
Cellphone | String | Mobiele nummer | 0612398745 |
VehiclePickedUpReceiptResource
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
downloadUrl | String | Url naar document incl sas-token. Deze is 7 dagen geldig. | |
Order | OrderReference | Referentie naar de OrderResource | Zie OrderReference |
Overige data
Aanvullende data objecten waarmee resources verrijkt kunnen zijn.
Address
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
streetName | String | Straatnaam | Spitsstraat |
houseNumber | String | Huisnummer en eventuele toevoegingen | 17a |
city | String | Plaats | Raalte |
postalCode | String | Postcode | 8102 HW |
countryIso2 | String | ISO2 Landcode | NL |
ChecklistItem
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
question | String | De vraag van een vragenlijst-item. | |
answer | String | Het antwoord op de vraag van een vargenlijst-item. |
ConsignmentNoteReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de detailsvrachtbrief | /tenants/1/orders/017d2890-01ff-4c40-bbe4- |
Coordinates
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
latitude | Double | Breedtegraad (Geodecimaal) | 52.380205 |
longitude | Double | Lengtegraad (Geodecimaal) | 6.2958919 |
InvoiceReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de details van deze factuur | /tenants/1/invoices/fc9036ec-eb4a-496c-8c77-e972e3e800aa |
ImOrderReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de details van deze imorder | /tenants/1/im-orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa |
JobBillingReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de details van deze jobbilling | /tenants/1/job-billings/fc9036ec-eb4a-496c-8c77-e972e3e800aa |
JobReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de details van deze behandeling | /tenants/1/jobs/fc9036ec-eb4a-496c-8c77-e972e3e800aa |
OrderAttachmentReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de detailsvrachtbrief | /tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/attachments/e32ea561-2ee5-45f6-8056-d4cf5b6e2c10 |
OrderChecklistReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de details van de vragenlijst | /tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/order-checklists/e32ea561-2ee5-45f6-8056-d4cf5b6e2c10 |
OrderLocationReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de details van deze locatie | /tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa/locations/0175acdc-6c37-4de1-a96c-f21a1a15d517 |
MainRoad
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
mileMarker | Double | Hectometerpaaltje | 123.4 |
mileMarkerAddition | String | Optioneel Toevoeging | d |
direction | String | Linker of rechter rijstrook
| Li |
roadName | String | Wegnaam | A2 |
countryIso2 | String | ISO2 Landcode | NL |
OrderReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de details van deze opdracht | /tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa |
RelationReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de details van deze opdracht | /tenants/1/relations/0167cc22-9511-4562-b51a-224142084fc1 |
StatusReport
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
jobStatus | String | Status historie van de behandeling
| Assigned |
timestamp | DateTimeOffset | Tijdstip van statusovergang | 2020-11-06T14:36:00.000+02:00 |
TowingVehiclePositionReference
Veld | Type | Omschrijving | Voorbeeld | |
|---|---|---|---|---|
resourceReference | String | Referentie naar de positie van het bergingsvoertuig | /tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa/towing-vehicle-position |
VehicleProperties
| Info |
|---|
Let op: Alle kenmerken van een voertuig zijn optioneel. Deze komen indien mogelijk uit het RDW en kunnen door de berger aangevuld worden. Maar kunnen dus ook de waarde |
Veld | Type | Omschrijving | Voorbeeld | ||
|---|---|---|---|---|---|
type | String | Soort voertuig
| Light | ||
make | String | Merk van het voertuig | Spyker | ||
model | String | Model van het merk | C8 Preliator | ||
color | String | Kleur | Oranje | ||
weightKg | Integer | Gewicht in kilogrammen | 1390 | ||
loadCapacityKg | Integer | Laadvermogen in kilogrammen | 180 | ||
lengthCm | Integer | Lengte van het voertuig in centimeters | 463 | ||
heightCm | Integer | Hoogte van het voertuig in centimeters | 127 | ||
widthCm | Integer | Breedte van het voertuig in centimeters | 273 | ||
fuelTypes | String | Brandstoftypes, comma gescheiden lijst indien dit er meerdere zijn. Zoals bij hybriede voertuigen | benzine, elektriciteit | ||
isManualGear | Boolean | Kenmerk of het voertuig handgeschakeld is (true), automaat heeft (false) of onbekend / niet van toepassing (null) | true | ||
is4x4 | Boolean | Kenmerk of het voertuig 4-wielaandrijving heeft
| false | ||
isForeign | Boolean | Kenmerk of het een buitenlandsvoertuig betreft | false | ||
isElectric | Boolean | Kenmerk of het voertuig elektrisch aangedreven is
| false | ||
apkExpireDate | DateTime | APK vervaldatum | 2020-12-31T22:00:00
| ||
hasInsurance | Boolean | Kenmerk of het voertuig verzekerd is | true | ||
driveShaft | String | Type aandrijving
| All | ||
yearOfManufacture | Integer | Bouwjaar | 2023 | ||
isTrailer | Booelan | Kenmerk of het voertuig een aanhanger is | false | ||
licensePlateCountryCode | String | Landcode zoals getoond op het kenteken | NL |
VehicleReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de details van dit voertuig | /tenants/1/vehicles/fc9036ec-eb4a-496c-8c77-e972e3e800aa |
VehicleState
| Info |
|---|
Let op: De informatie m.b.t. de staat van een voertuig is optioneel. Deze kunnen door de berger ingevuld worden. Maar kunnen dus ook de waarde |
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
isLocatedInWater | Boolean | Kenmerk of de auto te water is geraakt | true |
metersToQuay | Double | Afstand vanaf de kade in meters. Alleen van toepassing als de auto in het water ligt | 3.0 |
isRollable | Boolean | Kenmerk of het voertuig rolbaar is | true |
isSteeringWheelLocked | Boolean | Kenmerk of het stuurslot actief is (Bijvoorbeeld omdat de sleutel niet aanwezig is) | false |
hasTrailer | Boolean | Kenmerk of er een trailer bij betrokken is | false |
hasBikeCarrier | Boolean | Kenmerk of er een fietsendragen bij betrokken is | false |
hasRoofBox | Boolean | Kenmerk of er een dakkoffer bij betrokken is | false |
leakage | Boolean | Kenmerk of er een lekkage is, bijvoorbeeld olie | false |
locationKeys | String | Beschrijving waar de sleutels te vinden zijn | Op linker voorwiel |
locationDocuments | String | Beschrijving waar de autopapieren te vinden zijn | In dashboardkastje |
DriverReference
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
resourceReference | String | Referentie naar de bestuurder | /tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa/driver |
Voorbeeld
Voorbeeld JSON response van een ao.order.statuschanged event met de OrderResource. OrderLocationResource en LocationResource als aanvullende data.
...