...
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.
...
| 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
...
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 |
Resource data
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 | |||
|---|---|---|---|---|---|---|
downloadUrl | String | Url naar document incl sas-token. Deze is 7 dagen geldig. | name | String | Naam van het bestand. Deze is 7 dagen geldig. | |
name | String | 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. |
...
Veld | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
Salutation | String | 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.
...
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 |
...