Tour & Event Changes

This section provides a complete set of API calls to receive the actual execution of the planned tasks in every route. It allows also communicating real-time actions that might take place on the ground that were not initially planned, ensuring a flexible and responsive workflow.

The user who executes the planned routes can communicate the actuals of the planned tasks at the route level, stop level, and order task or any other task that might be planned to take place within the route, in addition to the communication of other unplanned events at the route level such as traffic jams, rest, etc… or other stop level events like waiting in a queue for example.

This level of control empowers your system to adapt according to a certain situation, enhancing the efficiency and accuracy of your route execution.

Available End Points

Update Order Task

The task involves managing tour event data within a working set.

Attribute	Data Type	Required	Description
workingsetID	String	Required	Identifier for the working set.
tourID	String	Required	Identifier for the tour.
tourEventDTO	Object	-	Tour event data transfer object.
tourEventDTO.id	String	-	Identifier for the tour event.
tourEventDTO.name	String	-	Name of the tour event.
tourEventDTO.actualStartTime	String	-	Actual start time of the tour event (formatted as "YYYY-MM-DDTHH:mm:ss.sssZ").
tourEventDTO.actualEndTime	String	-	Actual end time of the tour event (formatted as "YYYY-MM-DDTHH:mm:ss.sssZ").
tourEventDTO.tourEventType	Number	-	enum takes values: Rest, Traffic Jam, Acciednt, Break Down, Driving, Tanking, Maintenance, Available, Damage, Empty, Cancelled
tourEventDTO.location	Object	-	Location information for the tour event.
tourEventDTO.location.longitude	Number	-	Longitude coordinate of the location.
tourEventDTO.location.latitude	Number	-	Latitude coordinate of the location.

Update Order Task

POST https://api.normalive.ai/UpdateOrderTask

Endpoint for updating the order task.

Headers

Name	Type	Description
authentication*	String	Bearer token acquired after authentication

Request Body

Name	Type	Description
TourID*	string	Unique identifier for the tour
OrderId*	string	Unique identifier for the order
ActualEndDateTime	datetime	Actual end date and time of the task
ActualStartDateTime*	datetime	Actual start date and time of the task
TaskID*	string	Unique identifier for the task

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

{
  "tourID": "string",
  "orderID": "string",
  "taskID": "string",
  "actualStartDateTime": "2023-12-07T12:06:47.408Z",
  "actualEndDateTime": "2023-12-07T12:06:47.408Z"
}

Update Stop Task

Updating the stop within the task.

Attribute	Data Type	Required	Description
workingsetID	String	Required	Unique identifier for the working set.
tourID	String	Required	Unique identifier for the tour.
stopId	String	Reqiured	Identifier for the stop within the tour.
taskID	String	-	Unique identifier for the task.
actualStartDateTime	String	-	Actual start date and time of the task.
actualEndDateTime	String	-	Actual end date and time of the task.

Update Stop Task

POST https://api.normalive.ai/UpdateStopTask

Endpoint for updating the stop tasks.

Headers

Name	Type	Description
authentication*	string	Bearer token acquired after authentication

Request Body

Name	Type	Description
WorkingsetID*	string	Unique identifier for the working set
StopId*	string	Unique identifier for the stop
TaskID*	string	Unique identifier of the stop
ActualEndDateTime	datetime	Actual end date and time of the task
ActualStartDateTime*	datetime	Actual start date and time of the task

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

{
  "workingsetID": "string",
  "tourID": "string",
  "stopId": "string",
  "taskID": "string",
  "actualStartDateTime": "2023-12-07T12:07:25.229Z",
  "actualEndDateTime": "2023-12-07T12:07:25.229Z"
}

Update Tour Task

Updating the task within a tour.

Attribute	Data Type	Required	Description
workingsetID	String	Required	Unique identifier for the working set.
tourID	String	Required	Unique identifier for the tour.
taskID	String	Required	Unique identifier for the task.
driverID	String	Required	Identifier for the driver assigned to the task.
coDriverID	String	-	Identifier for the co-driver assigned to the task.
actualStartDateTime	String	-	Actual start date and time of the task.
actualEndDateTime	String	-	Actual end date and time of the task.

Update Tour Task

POST https://api.normalive.ai/UpdateTourTask

Endpoint for updating the tour tasks.

Headers

Name	Type	Description
authentication*	string	Bearer token acquired after authentication

Request Body

Name	Type	Description
WorkingsetID*	string	Unique identifier for the working set
ActualEndDateTime	datetime	Actual end date and time of the task
ActualStartDateTime*	datetime	Actual start date and time of the task
TaskID*	string	Unique identifier for the task
TourID*	string	Unique identifier for the tour

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

{
  "workingsetID": "string",
  "tourID": "string",
  "taskID": "string",
  "driverID": "string",
  "coDriverID": "string",
  "actualStartDateTime": "2023-12-07T12:08:44.077Z",
  "actualEndDateTime": "2023-12-07T12:08:44.077Z"
}

Stop Event

This communicates any unplanned event from predefined stop events that might take place at a specific stop

Attribute	Data Type	Required	Description
workingsetID	String	Required	Unique identifier for the working set.
tourID	String	Required	Unique identifier for the tour associated with the stop.
stopID	String	Required	Unique identifier for the stop within the tour.
stopEventDetails.id	String	-	Unique identifier for the stop event.
stopEventDetails.name	String	-	Name or description of the stop event.
stopEventDetails.actualStartTime	String	-	Actual start time of the stop event.
stopEventDetails.actualEndTime	String	-	Actual end time of the stop event.
stopEventDetails.stopEventType	Integer	-	enum takes values: None, Driving, Waiting, Container Mount, Container Dismount, Tanking, Customs, Rest, Accident.

Send Stop Event

POST http://20.79.248.210:5909/api/SendStopEvent

This endpoint will add a new stop event if its ID doesn’t exist and will update it if it already exists.

Headers

Name	Type	Description
authentication *	string	Bearer token acquired after authentication

Request Body

Name	Type	Description
StopEvent*	object of stop event type	Stop Event Object
StopID*	string	Unique identifier for the stop.
TourID*	string	Unique identifier for the tour.
WorkingsetID*	string	Unique identifier for the working set.

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

{
  "workingsetID": "string",
  "tourID": "string",
  "stopID": "string",
  "stopEventDetails": {
    "id": "string",
    "name": "string",
    "actualStartTime": "2023-12-10T21:16:44.380Z",
    "actualEndTime": "2023-12-10T21:16:44.380Z",
    "stopEventType": 0
  }
}

Tour Event

Its is a feature designed to facilitate the communication and tracking of events related to a logistics or transportation tour.

Attribute	Data Type	Required	Description
workingsetID	String	Required	Unique identifier for the working set.
tourID	String	Required	Unique identifier for the tour.
tourEventDetails.id	String	Required	Unique identifier for the tour event.
tourEventDetails.name	String	-	Name or description of the tour event.
tourEventDetails.actualStartTime	String	-	Actual start time of the tour event.
tourEventDetails.actualEndTime	String	-	Actual end time of the tour event.
tourEventDetails.tourEventType	Integer	-	Type of tour event (e.g., start, end, etc.).
tourEventDetails.location	Object	-	Geographic coordinates (longitude and latitude) of the event location.
tourEventDetails.location.longitude	Number	-	Longitude of the event location.
tourEventDetails.location.latitude	Number	-	Latitude of the event location.

Send Tour Event

POST https://api.normalive.ai/SendTourEvent

This endpoint will add a new tour event if its ID doesn’t exist and will update it if it already exists.

Headers

Name	Type	Description
authentication *	string	Bearer token acquired after authentication

Request Body

Name	Type	Description
TourEvent*	object of tour event	Tour Event Object
TourID*	string	Unique identifier for the tour.
WorkingsetID*	string	Unique identifier for the working set.

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

{
  "workingsetID": "string",
  "tourID": "string",
  "tourEventDetails": {
    "id": "string",
    "name": "string",
    "actualStartTime": "2023-12-10T21:17:16.533Z",
    "actualEndTime": "2023-12-10T21:17:16.533Z",
    "tourEventType": 0,
    "location": {
      "longitude": 0,
      "latitude": 0
    }
  }
}