NxtPort Push Barges Location API
Version: v1
Base URLs
-
<https://api-pushbarges.nxtport.com/v1>
Endpoints
POST /tracking/bargelocations
POST /tracking/bargelocations
Request body
The values for a bargelocation
application/json
JSON
{
"$ref": "#/components/schemas/BargeLocation"
}
Example:
JSON
null
Responses
|
Status |
Description |
Content type |
|---|---|---|
|
|
Ok |
— |
|
|
Bad Request |
— |
|
|
Unauthorized |
— |
|
|
Server Error |
— |
Data models
BargeLocation
JSON
{
"description": "References a specific location of a barge",
"required": [
"company",
"company_id",
"eni",
"lat",
"lon",
"timestamp_location"
],
"type": "object",
"properties": {
"company": {
"description": "Name of the Company",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"company_id": {
"description": "EORI number of the Company",
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"eni": {
"description": "European number of identification",
"maxLength": 8,
"minLength": 8,
"type": "string"
},
"heading": {
"format": "double",
"description": "Direction in degrees",
"maximum": 360,
"minimum": 0,
"type": "number"
},
"lat": {
"format": "double",
"description": "Latitude in WGS84 standard",
"maximum": 90,
"minimum": -90,
"type": "number"
},
"length": {
"format": "double",
"description": "Length in meters",
"type": "number"
},
"lon": {
"format": "double",
"description": "Longitude in WGS84 standard",
"maximum": 180,
"minimum": -180,
"type": "number"
},
"speed": {
"format": "double",
"description": "Speed in kilometers per hour",
"type": "number"
},
"timestamp_location": {
"format": "date-time",
"description": "Timestamp of the location (ISO 8601 formatted timestamp)",
"type": "string"
},
"timestamp_message": {
"format": "date-time",
"description": "Timestamp of the message (ISO 8601 formatted timestamp)",
"type": "string"
},
"width": {
"format": "double",
"description": "Width in meters",
"type": "number"
}
}
}