04-06-2018

RGB

Assignment.finishDateTime

Field added

04-06-2018

RGB

Location.locationRole

Enumerations mutated from Unload to Destination

Enumerations mutated from Depot to LayoverLocation

11-06-2018

RGB

Location.MainRoad.Direction

Non mandatory

08-08-2018

RGB

Assignment.type

Enumerations added for PlannableTransportation and PlannableTransportation.

Removed enumeration for Transportation

12-02-2019

RB

-

Added open-api (swagger) specification

28-01-2020

AB

Assignment.BillingAgreement

Added object BillingAgreements. Only with property FirstServiceKms for now.

17-07-2020

AB

Checklists

Added checklists

24-11-2020

MA

Assignment.BillingAgreement.SecondServiceKms

Added SecondServiceKms to BillingAgreements

09-07-2021

NW

UpdateAssignmentRequest

Added PUT endpoint for updating assignments and GET update-status for retrieving the status of the update

01-11-2021

NW

Assignment.FinishDateTimeSecondService

Added optional datetime field to provide the expected unload datetime of the transport after first service

14-04-2022

MA

Assignment.Cause

Added optional cause field

05-10-2022

AB

ExternalReferences

Added options field

09-12-2022

NW

Assignment

DateTime replaced by DateTimeOffset in CreateAssignmentRequests

25-01-2023

NW

Vehicle.Properties

Added DriveShaft (replacing is4x4) and YearOfManufacture

14-06-2023

AB

Vehicle.Properties

Added IsTrailer

07-08-2023

NW

Assignment.ReportedBy

Added ReportedBy field to Assignment

13-09-2023

AB

Contact.Email

Added Email field to Contact

04-09-2024

NW

Vehicle.Properties

Added LicensePlateCountryCode

type

Requested type of service

Enumeration

Yes

Breakdown, PlannableTransportation, NonPlannableTransportation, Damage, ErrorParked, Seizure, Security, AbandonedVehicle, Cleaning

receiver

Unique AO identifier for the towing company

String

Yes

1001

sender

Unique AO identifier for the customer

String

Yes

Allianz

debtor

Identifier of the paying party within the assignment, in case this isn't the sender

String

Allianz XX

description

Description of the (cause of the) event or requested services

String

Car drops oil

remark

Extra remark for the towing company

String

Driver is not with his vehicle 

customerReference

Unique reference from the customer 

String

S34897

purchaseOrderNumber

Purchase order reference as it will be shown on the invoice

String

P123456

invoiceText

Optional text which will be printed on the invoice

String

Costs to the direction of Jan Jansen

startDateTime

Requested start date/time from which point the assignment may be executed. This could be in the future. If empty the current date and time will be used

Date

2017-12-06T10:23:35.520Z

finishDateTime

Optional requested end date/time

Date

2017-12-06T10:23:35.520Z

finishDateTimeSecondService

Optional requested end date/time of transport after first service

Date

2017-12-06T10:23:35.520Z

orderDateTime

Optional order date/time. May be in the future. If empty the current time is used as the orderdate time

Date

2017-12-06T10:23:35.520Z

personsToTransport

Number of people to be transferred

Number

3

securityRequired

Security transport requested (only used for towing assignments)

Boolean

True

billingAgreements

Object with optional price agreements

BillingAgreements

cause

Optional text with the cause of the incidentexe

String

Accu

reportedBy

Optional name of the reporter

String

Jan Janssen

locationRole

Describes the role which the location has in the assignment. If the assignment does not require transportation, 1 location (load) will be sufficient

Enumeration

Yes

Load, Destination, LayoverLocation, PersonDestination, LuggageDestination

locationType

Describes if the location is a mainRoad or an address. Based on this choice the fields below the yellow lines (below) must be provided

Enumeration

Yes

mainRoad of address

remark

Remark for the provided location 

String

On crossroads with Central street 

name

Optional name of the location

String

Makro Zwolle

mainRoad (if locationType == mainRoad)

hmp

Hectometre post

Number

Yes

17.1

direction

Direction sign

Enumeration

Yes

Li of Re

roadname

Main road name (Highway)

String

Yes

A35

hmpaddition

Hectometre post addition

String

l

countryIso2

Countrycode in ISO2. If empty than default = NL 

String

Yes

NL

address (if locationType == address)

streetName

Streetname

String

Dorpstraat

houseNumber

Address number

String

Yes

18a

city

City

String

Zwolle

postalCode

Zip code

String

Yes

8102XC

countryIso2

Countrycode in ISO2. If empty then default = NL

String 

Yes

NL

coordinates

latitude

X coordinate in geodecimal formaat (DD)

Number

31.157845

longitude

Y coordinate in geodecimal formaat (DD)

Number

5.15478

restrictions

IsParkingGarage

Describes if the address provided is a parking garage 

Boolean

true

MinEuroclassification

Describes if the address is within a environmental zone

Number

5

openinghours (list)

dayOfWeek

Day of the week

Enumeration

Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

from

Start opening time

String

08:00

to

Eind opening time

String

18:00

contact (list)

Phone: the first contact with the name 'Phone'. The Phone field will be used

CellPhone: the first contact with the name 'CellPhone'. The Phone field will be used

Email: the first contact with the name 'Email'. The Email field will be used

The other contacts will be ignored.

Name

This field is not used and can be left out

String

Jan Jansen

Phone

Telephone number on which the location can be reached 

String

0123-4567890

Email

Email address

String

ao@rgbplus.nl

Role

This field is not used and can be left out

Enumeration

Primary, Other

ExternalIdentifier

External identifier

String

Yes

checklist1

Name

Name

String

Yes

Intake

ProcessStep

ChecklistProcessStep

For whom the checklist is intended: the order intake colleague or the driver. Options:

• OrderIntake

• DriverApp

Enumeration

Yes

OrderIntake

items: List of ChecklistItems

Id

Id

Number

Yes

1

Identifier

Identifier

String

Yes

checklist-item1

Description

Description

String

Yes

What is the mileage of the vehicle?

ChecklistItemType

ChecklistItemType

Options:

• Default

• Boolean

• Number

• Options

• Url

• Email

• Telephone

Enumeration

Yes

Number

Value

Value

Default value of the checklist item

String

12500

IsRequired

IsRequired

Boolean

Yes

true

ValidationRegex

ValidationRegex

Indicates against which regular expression the checklist answer should be validated

String

ValidationMessageKey

ValidationMessageKey

String

Options

Options

List with options. Used when ChecklistItemType is Options

List<String>

Yes (only when ChecklistItemType = Options)

• Option 1

• Option 2

• Option 3
  
  

licensePlate

License plate 

String

x

AB12AB

chassisNumber

Chassis number

String

234234SD23FDSF

mileage

Mileage at the point of service 

Number

123456

vehicleType

Description of the vehicle type

Enumeration

x

car, truck, trailer, boat, bike, other

remark

Remark of the vehicle

String

Burned down 

state

isLocatedInWater

Vehicle is in the water

Boolean

True

metersToQuay

Distance to quay

Number

18

isRollable

Vehicle is rollable

Boolean

True

isSteeringWheelLocked

Vehicle steering wheel is locked

Boolean

True

hasTrailer

Vehicle has trailer attached

Boolean

True

hasBikeCarrier

Vehicle has bike carrier attached

Boolean

True

hasRoofBox

Vehicle has roofbox

Boolean

True

locationKeys

Known location for keys

String

Under left wheel

locationDocuments

Known location for papers

String 

Dashbord

properties

make

Make of the vehcile

String

Ford

model

Type of the vehicle

String

Focus D1

color

Color of the vehicle

String

Zwart

weightKg

Weight of the empty vehicle

Number

1500

LengthCm

Length of the vehicle in cm 

Number

500

heightCm

Height of the vehicle in cm

Number

180

widthCm

Width of the vehicle in cm

Number

230

fuelType

Type of fuel system

Enumeration

Diesel, Gas, Benzine, Hybrid, Electric, Other

isManualGear

Manual gear 

Boolean

True

is4x4

4x4

Boolean

False

isForeign

Vehicle is not registered in the NL

Boolean

False

driveShaft

Drive shaft type

Enumeration

All, Front, Rear

yearOfManufacture

Year of manufacture

Number

2023

licensePlateCountryCode

Country code as displayed on the license plate

String

NL, B, D, E, F, GB

gender

Gender

Enumeration

male, female

initials

Initials

String

RCB

prefixes

Prefix

String

van der

firstName

First name

String

Ron 

lastName

Last name

String

Jansen

email

Email address

String

test@test.com

phone

Phone

String

0572-05721

cellphone

Cellphone

String

06-12345678

licenseNumber

Drivers license number

String

123456789

licenseExpires

Drivers license expiration date

Date

2018-01-01

address

streetName

Street

String

Dorsplein

houseNumber

House number

String

2s

city

City

String

Deventer

postalCode

Zip code

String

8101LK

countrIso2

Countrycode in ISO2. If empty, then default = NL

String

NL

name

Name insurance company

String

Achmea

policyNumber

Insurance policy number 

String

12345678

validTillDate

Expiration date of the policy

Date

2017-12-06

typeOfCoverage

Type of coverage of the vehicle

Enumeration

WA, WAplus, WACasco, nonInsured

policyOwnerDetails

gender

Gender

Enumeration

male, female

initials

Initials

String

RCB

prefixes

Prefix

String

van der

firstName

First name

String

Ron

lastName

Last name

String

Jansen

email

E-mail address

String

test@test.com

phone

Phone

String

0572-353535

cellphone

Cellphone

String

06-12312312

address

streetName

Street

String

Dorpstraat

houseNumber

House number

String

18a

city

City

String

Zwolle

postalCode

Zip code

String

8102XC

countryIso2

Countrycode in ISO2. If empty, then default = NL

String 

NL

FirstServiceKms

Price agreement for the distance to be charged of the first job

int

Yes

25

SecondServiceKms

Price agreement for the distance to be charged of the transport after first service job

int

No

75

Name

Name of the external reference

string

Yes

order-identificaton

Value

Value of the external reference

string

Yes

XV-006-HJIU-2022

success

Indicator if the request has been processed succesfully

Boolean

Yes

true

result

Textual result representation

String

Yes

InProgress

reasonNoSuccess

Not used in this context

String

No

changes: List of ChangeResultResponse

description

Textual description of the change

String

Yes

Edit Destination

status

Current status of the change

Enumeration

Yes

None,
Todo,
InProgress,
Applied,
Ignored,
Refused