ReportVehicleStored

Owned by Ard Broos
Sept 05, 2023
1 min read

General

A charter can notify your assignment has been stored on a location.

 

Specification

Endpoint route: POST /charter-assignments/{customerReference}/vehicle-storage-report

 

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/

 

Models

VehicleStoredReportRequest

Element

Description

Type

Mandatory

Example

Element

Description

Type

Mandatory

Example

Receiver

 

Identifier of the sender (customer) of the original order

string

yes

 

Sender

Unique AO identifier for the towing company

string

yes

 

CharterAssignmentId

External reference of the order

string

yes

 

Locations

Locations of the order

Location
See Report completion | Locations

InterimLocation is Mandatory, destination is optional

is

VehicleStoredReportResponse

Element

Description

Type

Mandatory

Example

Element

Description

Type

Mandatory

Example

Success

 

Indicator if the request has been processed successfully

boolean

yes

 

Result

Textual result representation

string

yes

 

ReasonNoSuccess

message to explain why not succeeded

string

no

 

CharterDestinationDiffers

true if the destination reported by the charter is not the same as the destination known by the customer

bool

No

Â