Get Norma Plan

The "Get Normal Plan" method is designed to provide customers with efficient and optimized plans for their specific needs. It shows the capabilities of our intelligent system.

Get Norma Plan Object

Within a working set, the system manages tours, each representing a accurately planned journey with a dedicated vehicle, driver, and associated tasks. The tour details include essential information such as vehicle specifications, driver details, route mode, creation and modification dates, and a breakdown of stops, orders, and tasks.

[
  {
    "workingsetID": "string",
    "tours": [
      {
        "id": "string",
        "vehicle": {
          "id": "string",
          "plateNumber": "string",
          "code": "string",
          "vehicleType": {
            "name": "string",
            "weight": 0,
            "volume": 0
          },
          "cost": 0,
          "maxAllowedTripTime": 0,
          "maxAllowedTripDistance": 0,
          "planningGroup": {
            "name": "string"
          }
          
        },
        "driver": {
          "id": "string",
          "code": "string",
          "name": "string",
          "phone": "string"
         
        },
        "routeMdode": 0,
        "trailers": [
          {
            "id": "string",
            "plateNumber": "string",
            
            "trailerType": {
              "name": "string"
            }
          }
        ],
        "creationDate": "2023-12-18T08:20:32.982Z",
        "lastModifiedDate": "2023-12-18T08:20:32.982Z",
        "stops": [
          {
            "node": {
              "id": "string",
              "name": "string",
              "address": {
                "street": "string",
                "number": "string",
                "zip": "string",
                "city": "string",
                "country": "string",
                "zone": "string"
              },
              "nodeType": 0,
              "timeWindows": [
                {
                  "date": "2023-12-18T08:20:32.982Z",
                  "timeSlots": [
                    {
                      "startTime": 0,
                      "endTime": 0
                    }
                  ]
                }
              ],
              "location": {
                "longitude": 0,
                "latitude": 0
              }
              
            },
            "orders": [
              {
                "orderID": "string",
                "orderDescription": "string",
                "customer": {
                  "id": "string",
                  "name": "string"
                },
                "creationDate": "2023-12-18T08:20:32.982Z",
                "lastModifiedDate": "2023-12-18T08:20:32.982Z",
                "orderStatus": 0,
                "planningGroup": {
                  "name": "string"
                },
                
                "orderTasks": [
                  {
                    "id": "string",
                    "name": "string",
                    "requestedTaskDueDate": "2023-12-18T08:20:32.982Z",
                    "requestedTimeSlot": {
                      "startTime": 0,
                      "endTime": 0
                    },
                    "orderTaskType": 0,
                    "alertPriority": 0,
                    "reference": "string",
                    "dispatched": true,
                    "trailer": {
                      "id": "string",
                      "plateNumber": "string",
                     
                      "trailerType": {
                        "name": "string"
                      }
                    },
                    "expectedStartTime": "2023-12-18T08:20:32.982Z",
                    "expectedEndTime": "2023-12-18T08:20:32.982Z",
                    "actualStartTime": "2023-12-18T08:20:32.982Z",
                    "actualEndTime": "2023-12-18T08:20:32.982Z",
                    "driver": {
                      "id": "string",
                      "code": "string",
                      "name": "string",
                      "phone": "string"
                    }
                  }
                ],
                "totalWeight": 0,
                "totalVolume": 0
              }
            ],
            "expectedDistance": 0,
            "actualDistance": 0,
            "stopTasks": [
              {
                "id": "string",
                "name": "string",
                "trailer": {
                  "id": "string",
                  "plateNumber": "string",
                  
                  "trailerType": {
                    "name": "string"
                  }
                },
                "stopTaskType": 0,
                "expectedStartTime": "2023-12-18T08:20:32.982Z",
                "expectedEndTime": "2023-12-18T08:20:32.982Z",
                "actualStartTime": "2023-12-18T08:20:32.982Z",
                "actualEndTime": "2023-12-18T08:20:32.982Z",
                "driver": {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "phone": "string"
                }
              }
            ],
            "stopEvents": [
              {
                "id": "string",
                "name": "string",
                "actualStartTime": "2023-12-18T08:20:32.982Z",
                "actualEndTime": "2023-12-18T08:20:32.982Z",
                "driver": {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "phone": "string"
                   
                },
                "stopEventType": 0
              }
            ],
            "stopStatus": 0
          }
        ],
        "tourStatus": 0,
        "tourTasks": [
          {
            "id": "string",
            "name": "string",
            "node": {
              "id": "string",
              "name": "string",
              "address": {
                "street": "string",
                "number": "string",
                "zip": "string",
                "city": "string",
                "country": "string",
                "zone": "string"
              },
              "nodeType": 0,
              "timeWindows": [
                {
                  "date": "2023-12-18T08:20:32.982Z",
                  "timeSlots": [
                    {
                      "startTime": 0,
                      "endTime": 0
                    }
                  ]
                }
              ],
              "location": {
                "longitude": 0,
                "latitude": 0
              }
            },
            "tourTaskType": 0,
            "expectedStartTime": "2023-12-18T08:20:32.982Z",
            "expectedEndTime": "2023-12-18T08:20:32.982Z",
            "actualStartTime": "2023-12-18T08:20:32.982Z",
            "actualEndTime": "2023-12-18T08:20:32.982Z",
            "driver": {
              "id": "string",
              "code": "string",
              "name": "string",
              "phone": "string"
              
            }
          }
        ],
        "tourLiveEvents": [
          {
            "id": "string",
            "name": "string",
            "actualStartTime": "2023-12-18T08:20:32.982Z",
            "actualEndTime": "2023-12-18T08:20:32.982Z",
            "driver": {
              "id": "string",
              "code": "string",
              "name": "string",
              "phone": "string" 
            },
            "tourEventType": 0,
            "location": {
              "longitude": 0,
              "latitude": 0
            }
          }
        ]
      }
    ],
    "distanceUnit": 0,
    "currency": 0
  }
]

Attributes Description

The "workingsetID" attribute is a string representing the unique identifier for the working set. It serves as a key to distinguish and reference different sets of working data within the system.

Attribute	Data Type	Required	Description
workingsetID	String	Required	The ID of the working set.
tours	List of objects	Required	A List of tour objects.
distanceUnit	Integer	-	The unit of distance for the tours.
currency	Integer	-	The currency used for the tours.

Tours

The "tours" attribute is a list of objects, each contains details about a specific tour. These details include information about the assigned vehicle, driver, route mode, trailers, creation and modification dates, stops, task assignments, and live events.

Attribute	Data Type	Required	Description
id	String	Required	The ID of the tour.
vehicle	Object	Required	Details about the vehicle assigned to the tour.
driver	Object	Required	Details about the driver assigned to the tour.
routeMode	Integer	-	The mode of the route.
trailers	List of objects	-	A List of trailer objects associated with the tour.
creationDate	String	-	The date and time when the tour was created.
lastModifiedDate	String	-	The date and time when the tour was last modified.
stops	List of objects	-	A list of stops included in the tour.
tourStatus	Integer	-	The status of the tour.
tourTasks	List of objects	-	A list of tasks associated with the tour.
tourLiveEvents	List of objects	-	A list of live events related to the tour.

Vehicle

It contains detailed information about the assigned vehicle.

Attribute	Data Type	Required	Description
id	string	Required	Unique identifier for the vehicle.
plateNumber	string	Required	License plate number of the vehicle.
code	string	Required	Code associated with the vehicle.
vehicleType	object	Required	Details about the type of vehicle.
cost	number	-	Cost associated with the vehicle.
maxAllowedTripTime	number	-	Maximum allowed trip time for the vehicle.
maxAllowedTripDistance	number	-	Maximum allowed trip distance for the vehicle.
planningGroup	object	-	Planning group associated with the vehicle.
vehicleDetails	List of vehicle details	-	List of additional details about the vehicle.

Driver

It contains details about the assigned driver. It includes the driver's ID, code, name, phone number, and comprehensive information on remaining driving hours, with various driving-related metrics and limits.

Attribute	Data Type	Required	Description
id	String	Required	The ID of the driver.
code	String	Required	The code associated with the driver.
name	String	-	The name of the driver.
phone	String	-	The phone number of the driver.
remainingDrivingHours	Object	-	Details about the remaining driving hours of the driver.

Trailers

The "trailers" attribute is a list of objects, each representing a trailer associated with the tour. Details include the trailer's ID, plate number, trailer details, and trailer type.

Attribute	Data Type	Required	Description
id	String	Required	The ID of the trailer.
plateNumber	String	Required	The plate number of the trailer.
trailerDetails	List of objects	Required	List of additional details about the trailer.
trailerType	Object	Required	Details about the type of trailer.

Stop

It includes details about the stopping node, such as its ID, name, address, and time windows.

Attribute	Data Type	Required	Description
node	Object	Required	Details about the stop node.
orders	List of objects	-	A list of orders associated with the stop.
expectedDistance	Integer	-	The expected distance of the stop.
actualDistance	Integer	-	The actual distance of the stop.
stopTasks	List of objects	-	A list of tasks associated with the stop.
stopEvents	List of objects	-	A list of events associated with the stop.
stopStatus	Integer	-	The status of the stop.

Tour Tasks

The "Tour Task" object represents a specific task within a tour. Each task is uniquely identified by an "id" and is associated with a designated node.

Attribute	Data Type	Required	Description
id	String	Required	The ID of the tour task.
name	String	-	The name of the tour task.
node	Object	-	Details about the node associated with the tour task.
tourTaskType	Integer	-	Takes values: Start, End
expectedStartTime	String	-	The expected start time of the tour task.
expectedEndTime	String	-	The expected end time of the tour task.
actualStartTime	String	_	The actual start time of the tour task.
actualEndTime	String	-	The actual end time of the tour task.
driver	Object	Required	Details about the driver assigned to the tour task.

Tour Live Events

Each event is uniquely identified by an "id" and includes details about the event type, actual start and end times, and the associated driver. The "location" attribute provides geographical coordinates for the event.

Attribute	Data Type	Required	Description
id	String	Required	The ID of the live event.
name	String	Required	The name of the live event.
actualStartTime	String	-	The actual start time of the live event.
actualEndTime	String	_	The actual end time of the live event.
driver	Object	-	Details about the driver associated with the live event.
tourEventType	Integer	-	enum takes values: Rest, Traffic Jam, Acciednt, Break Down, Driving, Tanking, Maintenance, Available, Damage, Empty, Cancelled
location	Object	Required	The location of the live event (latitude and longitude).

Node

The "node" object summarizes essential details about a location within the system. It includes information such as the node type, indicating its role or characteristics.

Attribute	Data Type	Required	Description
id	String	Required	Unique identifier for the node.
name	String	Required	Name associated with the node.
address	Object	Required	Address details, including street, number, zip, city, country, and zone.
nodeType	Number	Required	This property should take one of 6 values: Depot, Warehouse, Customer Location, Store, Home, Any
timeWindows	List of time windows	Required	List of time windows specifying available time slots for the node.
location	Object	Required	Geographic coordinates of the node (longitude and latitude).
nodeDetails	List of details	-	Additional key-value pairs for custom information related to the node.

Orders

This section represents crucial information about individual orders within the logistics system. Each order is uniquely identified by an "orderID," and optional details, such as a brief description.

Attribute	Data Type	Required	Description
orderID	string	Required	Unique identifier for the order.
orderDescription	string	Required	Description of the order.
customer	object	Required	Details about the customer associated with the order.
creationDate	string	-	Date and time when the order was created.
lastModifiedDate	string	-	Date and time when the order was last modified.
orderStatus	number	-	Status of the order.
planningGroup	object	-	Planning group associated with the order.
orderDetails	List of order details	-	List of additional details about the order.
orderTasks	List of order tasks	-	List of order task objects associated with the order.
totalWeight	number	-	Total weight of the order.
totalVolume	number	-	Total volume of the order.

Vehicle Type

The "vehicleType" object represents essential information about a specific type of vehicle within the system. It includes the name, which serves as a categorical identifier for the vehicle type.

Attribute	Data Type	Required	Description
name	String	Required	The name of the vehicle type.
weight	Number	Required	The weight associated with the vehicle type.
volume	Number	Required	The volume associated with the vehicle type.

Customer

This object has all the needed information about a customer involved in the logistics process. It includes a unique identifier and the customer name.

Attribute	Data Type	Required	Description
id	string	Required	Unique identifier for the customer.
name	string	-	Name of the customer.
customerDetails	List of customer details	-	List of additional details about the customer.

Order Task

It is associated with an order and represents a specific task to be performed.

Attribute	Data Type	Required	Description
id	string	Required	Unique identifier for the order task.
name	string	-	Name of the order task.
requestedTaskDueDate	string	-	Due date for the order task.
requestedTimeSlot	object	-	Time slot for the order task.
orderTaskType	number	-	enum takes values: Loading, Un Loading
alertPriority	number	-	Priority level for alerts related to the order task.
reference	string	-	Reference associated with the order task.
dispatched	boolean	-	Indicates whether the order task has been dispatched.
trailer	object	-	Details about the trailer associated with the order task.
expectedStartTime	string	-	Expected start time for the order task.
expectedEndTime	string	-	Expected end time for the order task.
actualStartTime	string	-	Actual start time for the order task.
actualEndTime	string	-	Actual end time for the order task.
driver	object	-	Details about the driver associated with the order task.

Stop Task

This object contains details such as a unique identifier, task name, associated trailer details, expected and actual start and end times, and driver information.

Attribute	Data Type	Required	Description
id	string	Required	Unique identifier for the stop task.
name	string	-	Name of the stop task.
trailer	object	-	Details about the trailer associated with the stop task.
stopTaskType	number	-	enum takes values: Arriving, Leaving, Disconnect, Connect, Park, Drive Away, Home
expectedStartTime	string	-	Expected start time for the stop task.
expectedEndTime	string	-	Expected end time for the stop task.
actualStartTime	string	-	Actual start time for the stop task.
actualEndTime	string	-	Actual end time for the stop task.
driver	object	-	Details about the driver associated with the stop task.

Stop Event

It illustrates the specific event that occurs during a stop. It holds information about the event's unique identifier, name, actual start and end times, associated driver details, event type, and geographic location.

Attribute	Data Type	Required	Description
id	string	Required	Unique identifier for the stop event.
name	string	-	Name of the stop event.
actualStartTime	string	-	Actual start time for the stop event.
actualEndTime	string	-	Actual end time for the stop event.
driver	object	-	Details about the driver associated with the stop event.
stopEventType	number	-	Type of the stop event.

Planning Group

It shows the essential details about a specific planning group. It includes a unique name identifier and an array of key-value pairs, allowing for additional descriptive details related to the planning group

Attribute	Data Type	Required	Description
name	string	Required	Name of the planning group.
details	List of planning group details	-	List of additional details about the planning group.

Available Endpoints

GET https://api.normalive.ai/GetManualPlan

Receive the permission for planning.

Headers

Name	Type	Description
Authentication *	String	Bearer token acquired after authentication

200: OK Get Norma Plan object

400: Bad Request