Report completion
- 1 General
- 2 Specification
- 2.1 TEST
- 2.2 PROD
- 2.3 XSD
- 2.4 Example messages
- 2.5 Models
- 2.5.1 CompletionReportRequest
- 2.5.2 TimeRegistrations
- 2.5.3 Locations
- 2.5.4 Route
- 2.5.5 FinalResult
- 2.5.6 ConsignmentNotes
- 2.5.7 CompletedChecklists
- 2.5.8 Attachments
- 2.5.9 Vehicle
- 2.5.10 ExternalReference
- 2.5.11 VehicleStorage
- 2.5.12 JobBillingInvoiceLine
General
This event is emitted when a salvor has completed his order.
Specification
TEST
Open-api specification: https://berger.test.assistanceonline.nl/api/assignments-external/v2/swagger/v1/swagger.json
Swagger-ui: https://berger.test.assistanceonline.nl/api/assignments-external/v2/swagger/
PROD
Open-api specification: https://berger.assistanceonline.nl/api/assignments-external/v2/swagger/v1/swagger.json
Swagger-ui: https://berger.assistanceonline.nl/api/assignments-external/v2/swagger/
XSD
Example messages
Models
CompletionReportRequest
General set of fields, describing the general completion characteristics.
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
Receiver | Identifier of the sender (customer) of the original order | String | Yes | Van Eijck |
Sender | Unique AO identifier for the towing company | String | Yes | tenant-1 |
SalvorCode | Unique identifier for the towing company | String | No | 2050 |
CharterAssignmentId | External reference of the order | String | No |
|
Comment | Comment given by the towing company when the order is completed | String | No |
|
District | The district in which the incident location is located | String | No | O77 |
RoadType | The roadtype of the incident location | Enumeration | No | Unknown = 0, |
Solution | The given solution for the vehicle which has been filled by the executing salvor | String | No | Changed battery |
CommentsToCustomer | Additional comment | String | No |
|
ExternalReferences | Name-value collection as sent by the customer during ordercreation | Collection of ExternalReferences | No |
|
VehicleStorage | Object with data of the storage of the vehicle | VehicleStorage | No |
|
InvoiceLines | Invoice lines | Collection of JobBillingInvoiceLines. Only applicable for chartered orders. | No |
|
EntryDate | The datetime of when incident was reported. | Date | No | 2024-06-06T10:25:55.620Z |
TimeRegistrations
A list of time registrations for each action the executing salvor has performed.
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
Type | The performed action | Enumeration | No | None = 0, |
Timestamp | The datetime of when the action was performed | Date | No | 2021-12-06T10:23:35.520Z |
LocationIndex | Index corresponding with the From/To of the Leg | Integer | No | 1 |
ReasonForLateArrival | Reason for why the executing salvor was too late on the given incident location. This is a list with fixed values. | String | No | Traffic jam |
LegId | Unique identifier of the leg | Guid | No |
|
Locations
List of key value pairs consisting of a GUID and the Location. Describes the location and the role it takes in the assignment. This could be a public road or an address.
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
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 = 0, |
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 | Unknown = 0, |
Remark | Remark for the provided location | String | No | On crossroads with Central street |
Name | Optional name of the location | String | No | Makro Zwolle |
MainRoad (if locationType == mainRoad) | ||||
Hmp | Hectometre post | Number | Yes | 17.1 |
Direction | Direction sign | Enumeration | Yes | Unknown = 0, |
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. Note: this field is not used at the moment. | Boolean |
| true |
MinEuroclassification | Describes if the address is within a environmental zone Note: this field is not used at the moment. | Number |
| 5 |
| ||||
OpeningHours (list) | ||||
DayOfWeek | Day of the week | Enumeration |
| Sunday = 0, |
From | Start opening time | String |
| 08:00 |
To | Eind opening time | String |
| 18:00 |
| ||||
Contacts (list) | ||||
Name | Name of contact / department | String |
| Jan Jansen |
Phone | Telephone on which the contact could be reached | String |
| 0123-4567890 |
Role | Enumeration describing the relation of the contact and the location | Enumeration | Yes | Primary = 0, |
Route
List of legs that the vehicle in need of service has been transported.
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
Id | Unique identifier of the leg | Guid | No |
|
From | The index of the location | Integer | No | 0 |
To | The index of the location | Integer | No | 1 |
FinalResult
The result of the order. Describing what was the cause of the incident and what the executing salvor did to solve this.
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
Type | The type of assignment | Enumeration | No | Breakdown = 0, |
AssignmentResultType | The result of the assignment | Enumeration | No | None = 0, |
Cause | The cause of the incident | String | No | Battery |
ConsignmentNotes
List of consignment notes which can be downloaded.
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
Id | Unique identifier of the consignment note | Guid | No |
|
LegId | Note: This field is not used and always empty (0) | Integer | No | 0 |
PdfUri | Public download URI which can be used to download the consignment note. Note: this link is valid for 7 days | String | No |
|
CompletedChecklists
List of checklists with questions that the salvor company has answered.
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
ExternalIdentifier | Unique identifier of the checklist | String | No | checklist1 |
ChecklistName | Name of the checklist | String | No | Intake checklist |
ProcessStep | For whom the checklist is intended: the order intake colleague or the driver | Enumeration | No | None = 0, |
AnsweredAt | The moment that the salvor completed the checklist | Date | No | 2021-12-06T10:23:35.520Z |
| ||||
ChecklistAnswers (list) | ||||
Id | The identifier of the checklist answer | Integer | No | 1 |
Identifier | The identifier of the question | String | No | question-1 |
Value | The answer | String | No | 12500 |
Attachments
List of attachments that are attached to the order by the salvor company.
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
Uri | Public download URI which can be used to download the attachment. Note: this link is valid for 7 days | String | No |
|
Filename | Name of the attachment | String | No | frontofvehicle.png |
MimeType | The mime type of the attachment | String | No | image/png |
Name | Internal file name of the attachment | String | No |
|
Vehicle
Description of the vehicle in need of service.
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
LicensePlate | License plate | String | Yes | AB12AB |
ChassisNumber | Chassis number | String | No | 234234SD23FDSF |
Mileage | Mileage at the point of service | Number | No | 123456 |
VehicleType | Description of the vehicle type | Enumeration | Yes | Car = 0, |
Remark | Remark of the vehicle | String | No | Burned down |
| ||||
State | ||||
IsLocatedInWater | Vehicle is in the water | Boolean | No | True |
MetersToQuay | Distance to quay | Number | No | 18 |
IsRollable | Vehicle is rollable | Boolean | No | True |
IsSteeringWheelLocked | Vehicle steering wheel is locked | Boolean | No | True |
HasTrailer | Vehicle has trailer attached Note: this field is not used at the moment. | Boolean | No | True |
HasBikeCarrier | Vehicle has bike carrier attached Note: this field is not used at the moment. | Boolean | No | True |
LocationKeys | Known location for keys Note: this field is not used at the moment. | String | No | Under left wheel |
LocationDocuments | Known location for papers Note: this field is not used at the moment. | String | No | Dashboard |
| ||||
Properties | ||||
Make | Make of the vehicle | String | No | Ford |
Model | Type of the vehicle | String | No | Focus D1 |
Color | Color of the vehicle | String | No | Zwart |
WeightKg | Weight of the empty vehicle | Number | No | 1500 |
LengthCm | Length of the vehicle in cm | Number | No | 500 |
HeightCm | Height of the vehicle in cm | Number | No | 180 |
WidthCm | Width of the vehicle in cm | Number | No | 230 |
FuelType | Type of fuel system | Enumeration | No | Diesel = 0, |
IsManualGear | Manual gear | Boolean | No | True |
Is4x4 | 4x4 | Boolean | No | False |
IsForeign | Vehicle is not registered in the NL | Boolean | No | False |
IsElectric | Vehicle is electric | Boolean | No | False |
ExternalReference
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
name | name of the reference | string | yes |
|
value | value of the reference | string | Yes |
|
VehicleStorage
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
StorageStarted | DateTime the storage started | Date | Yes |
|
StorageEnded | DateTime the storage ended | Date | No |
|
ChargeNumberOfDays | Number of days of the storage that are charged | number | No |
|
IsPickedUp | bool indicating the vehicle is pickedup | bool | Yes |
|
IsPickedUpBy | name of the person who pickedup the vehicle | string | No |
|
PdfUri | Uri with sastoken to the picked up receipt | string | No |
|
JobBillingInvoiceLine
Element | Description | Type | Mandatory | Example |
---|---|---|---|---|
LegId | Unique identifier for the invoice item | String | Yes |
|
Description | Description of the invoice item | String | Yes |
|
Price | price of the item | Decimal | Yes |
|