1 Webhook Events
2 Definities
- 2.1 Event data
- 2.2 Resource data
  - 2.2.1 ConsignmentNoteResource
  - 2.2.2 JobBillingResource
  - 2.2.3 JobResource
  - 2.2.4 IMOrderDetailsResource
  - 2.2.5 InvoiceResource
  - 2.2.6 LocationResource
  - 2.2.7 OrderAttachment
  - 2.2.8 OrderChecklist
  - 2.2.9 OrderResource
  - 2.2.10 RelationResource
  - 2.2.11 TowingVehiclePositionResource
  - 2.2.12 VehicleResource
  - 2.2.13 DriverResource
  - 2.2.14 VehiclePickedUpReceiptResource
- 2.3 Overige data
  - 2.3.1 Address
  - 2.3.2 ChecklistItem
  - 2.3.3 ConsignmentNoteReference
  - 2.3.4 Coordinates
  - 2.3.5 InvoiceReference
  - 2.3.6 ImOrderReference
  - 2.3.7 JobBillingReference
  - 2.3.8 JobReference
  - 2.3.9 OrderAttachmentReference
  - 2.3.10 OrderChecklistReference
  - 2.3.11 OrderLocationReference
  - 2.3.12 MainRoad
  - 2.3.13 OrderReference
  - 2.3.14 RelationReference
  - 2.3.15 StatusReport
  - 2.3.16 TowingVehiclePositionReference
  - 2.3.17 VehicleProperties
  - 2.3.18 VehicleReference
  - 2.3.19 VehicleState
  - 2.3.20 DriverReference
3 Voorbeeld

Webhook Events

Overzicht van de verschillende webhook events waarop ingehaakt kan worden.

nl.assistanceonline.webhooks.orderstatuschanged.v1

Gaat af bij iedere mutatie van de dossierstatus. De huidige statussen die in AO voorkomen:

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)

Wanneer de status Assigned of Arrived is, kan er indien ingesteld en beschikbaar de meest recente bergingsvoertuigpositie meegestuurd worden. Zie TowingVehiclePositionResource.

nl.assistanceonline.webhooks.jobetacalculated.v1

Gaat af zodra de chauffeur zich onderweg meldt richting de incidentlocatie. Hier kan een vertraging van 30 seconden inzitten.
Ook gaat dit event af als de planner de ETA herberekend.

Let op: Dit event gaat niet af voor transportopdrachten en opdrachten die toegewezen zijn aan een charter

Let op: Voor de ETA webhook kunnen kosten worden berekend.

nl.assistanceonline.webhooks.consignmentnoteadded.v1

Gaat af op het moment dat er een pdf voor een vrachtbrief is gegenereerd.

nl.assistanceonline.webhooks.orderattachmentadded.v1

Gaat af op het moment dat er een bijlage aan een opdracht is toegevoegd.

nl.assistanceonline.webhooks.invoicefinalized.v1

Gaat af op het moment dat de pdf van de factuur is gegenereerd. Dit is vlak nadat de factuur gefinaliseerd is.

nl.assistanceonline.webhooks.orderchecklistsaved.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.

Event data

Ieder event heeft drie vaste velden, de overige velden zijn afhankelijk van het type event.

Veld	Type	Omschrijving	Voorbeeld

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

"/tenants/1/orders/017a1434-117a-4d6f-8842-3fa81e0427d4": {

/* orderdata */

}

nl.assistanceonline.webhooks.orderstatuschanged.v1

Status mutaties van een dossier in AO:

{
    "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

Veld	Type	Omschrijving	Voorbeeld
orderNumber	String	Ordernummer zoals bekend in AO Let op: Dit veld is leeg bij nog niet geaccepteerde opdrachten	O-2387923
previousStatus	String	Vorige opdrachtstatus (zie OrderStatusChanged voor events)	New
newStatus	String	Nieuwe opdrachtstatus	Accepted

nl.assistanceonline.webhooks.jobetacalculated.v1

json voorbeeld bericht

{
    "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

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	Zie OrderLocationReference
destination	OrderLocationResourceReference	Referentie naar de eindbestemming van de behandeling. Dit kan bijvoorbeeld het depot zijn van de berger of het thuisadres van de berijder	Zie OrderLocationReference
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 (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

nl.assistanceonline.webhooks.consignmentnoteadded.v1

json voorbeeld bericht

{
    "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

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

json voorbeeld bericht

Veld	Type	Omschrijving	Voorbeeld

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

json voorbeeld bericht

Veld	Type	Omschrijving	Voorbeeld

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

json voorbeeld bericht

Veld	Type	Omschrijving	Voorbeeld

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

Veld	Type	Omschrijving	Voorbeeld

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

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

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

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	Zie RelationReference
invoice	InvoiceReference	Referentie naar factuurinformatie (InvoiceResource wordt nog niet meegestuurd)	Zie InvoiceReference

JobResource

Veld	Type	Omschrijving	Voorbeeld

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	Zie OrderLocationReference
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

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	Zie RelationReference
customer	RelationReference	Referentie naar relatiedetails van de opdrachtgever	Zie RelationReference
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 Accepted (Geaccepteerd) Assigned (Toegewezen) Enroute (Onderweg) Arrived (Ter plaatse) Empty (Loze rit)	Assigned
incidentLocation	OrderLocationReference	Locatie van het incident	Zie OrderLocationReference

InvoiceResource

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
debtor	RelationReference	Referentie naar relatiedetails van de debiteur	Zie RelationReference
company	RelationReference	Referentie naar relatiedetails van de uitvoerende berger	Zie RelationReference
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	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

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	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

Veld	Type	Omschrijving	Voorbeeld
downloadUrl	String	Url naar document incl sas-token. Deze is 7 dagen geldig.
name	String	Naam van het bestand
description	String	Omschrijving
documentType	String	Type bijlage Picture (Foto) MobilityDocument (Mobiliteitsdossier) DriversLicense (Rijbewijs) DamageReport (Schaderapport) ConsignmentNote (Vrachtbrief) Other (Overig) PickedUpReceipt (Afhaalbewijs) PaymentGuarantee (Betalingsgarantie) IndemnityCertificate (Vrijwaringsbewijs)	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

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

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	Zie RelationReference
customer	RelationReference	Referentie naar relatiedetails van opdrachtgever	Zie RelationReference
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	Zie OrderLocationReference
interimLocations	OrderLocationReference[]	Lijst met eventuele tussenbestemmingen	Zie OrderLocationReference
destinationLocation	OrderLocationReference[]	Eindbestemming van het voertuig dat is betrokken bij deze opdracht	Zie OrderLocationReference
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	Zie JobBillingReference
towingVehiclePosition	TowingVehiclePositionReference	Referentie naar de positie van het bergingsvoertuig	Zie TowingVehiclePositionReference

RelationResource

Veld	Type	Omschrijving	Voorbeeld

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

Veld	Type	Omschrijving	Voorbeeld

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

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	Zie VehicleProperties

DriverResource

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
Salutation	String	Aanhef	De heer
Initials	String	Initialen	R.G.
Prefixes	String	Voorvoegsels	van der
Name	String	Naam	Janssens
Email	String	Email adres	r.janssens@gmail.com
Phone	String	Telefoonnummer	0524365987
Cellphone	String	Mobiele nummer	0612398745

VehiclePickedUpReceiptResource

Veld	Type	Omschrijving	Voorbeeld

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

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

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

Veld	Type	Omschrijving	Voorbeeld
resourceReference	String	Referentie naar de detailsvrachtbrief	/tenants/1/orders/017d2890-01ff-4c40-bbe4- 577bb50013df/consignment-notes/Load

Coordinates

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
latitude	Double	Breedtegraad (Geodecimaal)	52.380205
longitude	Double	Lengtegraad (Geodecimaal)	6.2958919

InvoiceReference

Veld	Type	Omschrijving	Voorbeeld

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

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

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

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

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

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

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

Veld	Type	Omschrijving	Voorbeeld
mileMarker	Double	Hectometerpaaltje	123.4
mileMarkerAddition	String	Optioneel Toevoeging	d
direction	String	Linker of rechter rijstrook Re Li	Li
roadName	String	Wegnaam	A2
countryIso2	String	ISO2 Landcode	NL

OrderReference

Veld	Type	Omschrijving	Voorbeeld

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

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

Veld

Type

Omschrijving

Voorbeeld

jobStatus

String

Status historie van de behandeling

Created (Nieuw)
Assigned (Toegewezen)
FirstActivityEnroute (Onderweg naar laad/incident locatie)
FirstActivityArrived (Ter plaatse op incident/laad locatie)
FirstActivityStarted (Activiteit gestart op incident/laad locatie)
FirstActivityDone (Activiteit op incident/laad locatie gereed)
SecondActivityEnroute (Onderweg naar loslocatie)
SecondActivityArrived (Ter plaatse op loslocatie)
SecondActivityStarted (Begonnen met lossen)
Completed (Behandeling gereed)

Assigned

timestamp

DateTimeOffset

Tijdstip van statusovergang

2020-11-06T14:36:00.000+02:00

TowingVehiclePositionReference

Veld	Type		Omschrijving	Voorbeeld

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

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
type	String	Soort voertuig Light (Licht voertuig, gewicht minder dan 3500 kg) Heavy (Zwaar voertuig, gewicht groter of gelijk aan 3500) Bike (Fiets) Scooter (scooter, bromfiets)	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 Unknown Front Rear All	All
yearOfManufacture	Integer	Bouwjaar	2023
isTrailer	Booelan	Kenmerk of het voertuig een aanhanger is	false
licensePlateCountryCode	String	Landcode zoals getoond op het kenteken	NL B D

VehicleReference

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
resourceReference	String	Referentie naar de details van dit voertuig	/tenants/1/vehicles/fc9036ec-eb4a-496c-8c77-e972e3e800aa

VehicleState

Veld	Type	Omschrijving	Voorbeeld

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

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.

Webhooks

Webhook Events

nl.assistanceonline.webhooks.orderstatuschanged.v1

nl.assistanceonline.webhooks.jobetacalculated.v1

nl.assistanceonline.webhooks.consignmentnoteadded.v1

nl.assistanceonline.webhooks.orderattachmentadded.v1

nl.assistanceonline.webhooks.invoicefinalized.v1

nl.assistanceonline.webhooks.orderchecklistsaved.v1

nl.assistanceonline.resources.vehicle-pickedup-receipt.v1

Definities

Event data

nl.assistanceonline.webhooks.orderstatuschanged.v1

nl.assistanceonline.webhooks.jobetacalculated.v1

nl.assistanceonline.webhooks.consignmentnoteadded.v1

nl.assistanceonline.webhooks.orderattachmentadded.v1

nl.assistanceonline.webhooks.invoicefinalized.v1

nl.assistanceonline.webhooks.orderchecklistsaved.v1

nl.assistanceonline.resources.vehicle-pickedup-receipt.v1

Resource data

ConsignmentNoteResource

JobBillingResource

JobResource

IMOrderDetailsResource

InvoiceResource

LocationResource

OrderAttachment

OrderChecklist

OrderResource

RelationResource

TowingVehiclePositionResource

VehicleResource

DriverResource

VehiclePickedUpReceiptResource

Overige data

Address

ChecklistItem

ConsignmentNoteReference

Coordinates

InvoiceReference

ImOrderReference

JobBillingReference

JobReference

OrderAttachmentReference

OrderChecklistReference

OrderLocationReference

MainRoad

OrderReference

RelationReference

StatusReport

TowingVehiclePositionReference

VehicleProperties

VehicleReference

VehicleState

DriverReference

Voorbeeld