Versions Compared

Old Version 18

changes.mady.by.user Mark Alferink

Saved on

compared with

New Version 19

changes.mady.by.user Ard Broos

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

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

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.

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.

...

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

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

...

nl.assistanceonline.webhooks.consignmentnoteadded.v1

json voorbeeld bericht

Code Block
languagejson
{
    "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/consignmentnotes/load",
    "eventType": "nl.assistanceonline.webhooks.consignmentnoteadded.v1",
    "resources": {
        "/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/consignmentnotes/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

json voorbeeld bericht

Code Block
{
    "downloadUrl": "url with sastoken",
    "name": "download (1).jfif",
    "orderNumber": "O-0000357",
    "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

downloadUrl

string

url naar document incl sas-token. Deze is 7 dagen geldig.

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

JobBillingResource

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

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

...

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

...

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

...

company

...

RelationReference

...

Referentie naar relatiedetails van de uitvoerende berger

...

Zie RelationReference

...

customer

...

RelationReference

...

Referentie naar relatiedetails van 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)

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

...

Zie OrderLocationReference

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

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

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

company

RelationReference

Referentie naar relatiedetails van de uitvoerende berger

Zie RelationReference

customer

RelationReference

Referentie naar relatiedetails van 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)

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

Zie OrderLocationReference

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

OrderAttachment

Veld

Type

Omschrijving

Voorbeeld

downloadUrl

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.

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

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 JobReference

...

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

ConsignmentNoteReference

Veld

Type

Omschrijving

Voorbeeld

resourceReference

String

ISO2 Landcode

NL

Referentie naar de detailsvrachtbrief

/tenants/1/orders/017d2890-01ff-4c40-bbe4-
577bb50013df/consignmentnotes/load

Coordinates

Veld

Type

Omschrijving

Voorbeeld

latitude

Double

Breedtegraad (Geodecimaal)

52.380205

longitude

Double

Lengtegraad (Geodecimaal)

6.2958919

...

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

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

...