HBSA Internal
  1. Maneuvers
HBSA Internal
  • Hidrovias do Brasil APIs
  • Autenticação
    • Introdução
  • WebSockets
    • Introdução
    • Navigation
      • Admin Hub
      • Live Assets Hub
  • REST
    • Introdução
    • Navigation
      • AssetClasses
        • Lists all AssetClasses
        • Adds a new AssetClass
        • Finds a AssetClass by its identification
        • Partially updates a AssetClass
        • Deletes a AssetClass by its identification
      • Assets
        • List all assets
        • Create the primary data for an Asset
        • Finds a Certificates by its identification
        • Partially updates a Certificates
        • Deletes a Certificates by its identification
        • Lists all Checkpoints
        • Adds a new Checkpoint
        • Finds a Checkpoint by its identification
        • Deletes a Checkpoint by its identification
        • Partially updates a Checkpoint
        • Lists all DraftWeights
        • Adds a new DraftWeight
        • Deletes a DraftWeight by its identification
        • Lists all Fuels
        • Adds a new Fuel
        • Deletes a Fuel by its identification
        • Lists all AssetLocationss
        • Adds a new AssetLocations
        • Deletes a AssetLocations by its identification
        • Lists all Maintenance
        • Adds a new Maintenance
        • Finds a Maintenance by its identification
        • Partially updates a Maintenance
        • Deletes a Maintenance by its identification
        • Get the primary data of an Asset by Id
        • Partially updates a Primary Asset
        • Delete an asset by identification
        • Lists all Certificates
        • Adds a new Certificate
        • Get Asset Types
      • CertificateDepartaments
        • Lists all CertificateDepartaments
        • Adds a new CertificateDepartament
        • Finds a CertificateDepartament by its identification
        • Partially updates a CertificateDepartament
        • Deletes a CertificateDepartament by its identification
      • CertificateTypes
        • Lists all CertificateTypes
        • Adds a new CertificateType
        • Finds a CertificateType by its identification
        • Partially updates a CertificateType
        • Deletes a CertificateType by its identification
      • Clients
        • List all Clients
        • Get the primary data of an Client by Id
      • Contracts
        • List all Contract
        • Get the primary data of an Contract by Id
      • Crews
        • Lists all Crews
        • Adds a new Crew
        • Finds a Crew by its identification
        • Partially updates a Crew
        • Deletes a Crew by its identification
      • Embeddeds
        • Initialize embedded data sync
      • Employees
        • Lists all Employeess
        • Adds a new Employees
        • Finds a Employees by its identification
        • Partially updates a Employees
        • Deletes a Employees by its identification
      • Locations
        • Lists all locations
        • Adds a new location
        • Finds a location by its identification
        • Partially updates a location
        • Deletes a location by its identification
        • Get Location Types
      • ManeuverEvents
        • List all Maneuvers Events by filter
      • Maneuvers
        • List all Maneuvers by filter
          GET
        • Adds or updates a Maneuver
          POST
        • Get Maneuver Restrictions
          GET
        • Finds a maneuver by its identification
          GET
      • Onboards
        • Lists all Onboards
        • Adds a new Onboard
        • Finds a Onboard by its identification
        • Partially updates a Onboard
        • Deletes a Onboard by its identification
      • Products
        • Get the primary data of an Product by Id
      • Regions
        • Lists all Regions
      • Routes
        • Lists all Routes
        • Adds a new Route
        • Finds a Route by its identification
        • Partially updates a Route
        • Deletes a Route by its identification
        • Lists all RouteStretches
        • Adds a new stretche to a route
        • Adds a new list of stretche to a route
        • Deletes a RouteStretch by its identification
      • Stretches
        • Lists all Stretchs
        • Adds a new Stretch
        • Finds a Stretch by its identification
        • Partially updates a Stretch
        • Deletes a Stretch by its identification
        • Lists all StretchAttributes
        • Adds a new StretchAttribute
        • Finds a Stretch Attributes by its identification
        • Deletes a StretchAttribute by its identification
        • Partially updates a StretchAttribute
        • Partially updates a StretchAttribute
      • Tenants
        • List all assets
      • ThirdTravelCalendars
        • Lists all ThirdTravelCalendars
        • Adds a new ThirdTravelCalendar
        • Finds a ThirdTravelCalendar by its identification
        • Partially updates a ThirdTravelCalendar
        • Deletes a ThirdTravelCalendar by its identification
      • Thirds
        • Lists all Thirds
        • Adds a new Third
        • Finds a Third by its identification
        • Partially updates a Third
        • Deletes a Third by its identification
      • Travels
        • Lists all Travels
        • Adds a new Travel
        • Partially updates a Travel
        • Finds a Travel by its identification
        • Deletes a Travel by its identification
        • Lists all LoadUnloads
        • Adds a new LoadUnload
        • Finds a LoadUnload by its identification
        • Partially updates a LoadUnload
        • Deletes a LoadUnload by its identification
        • Lists all TravelStretches
        • Adds a new TravelStretch
        • Finds a TravelStretch by its identification
        • Partially updates a TravelStretch
        • Deletes a TravelStretch by its identification
        • Lists all TravelStretchAttributes
        • Adds a new TravelStretchAttributes
        • Finds a TravelStretchAttributes by its identification
        • Partially updates a TravelStretchAttributes
        • Deletes a TravelStretchAttributes by its identification
        • Lists all StretchPushers
        • Adds a new StretchPusher
        • Finds a StretchPusher by its identification
        • Partially updates a StretchPusher
        • Deletes a StretchPusher by its identification
        • Lists all PusherBarges
        • Adds a new PusherBarge
        • Finds a PusherBarge by its identification
        • Partially updates a PusherBarge
        • Deletes a PusherBarge by its identification
  1. Maneuvers

List all Maneuvers by filter

Amb. de testes
https://apis.qa01.hbsa.com.br/navigation
Amb. de testes
https://apis.qa01.hbsa.com.br/navigation
GET
/v1/maneuvers

Requisição

Parâmetros Query
assetId
string <uuid>
opcional
Asset Id
locationOriginId
string <uuid>
opcional
Location Origin Id
locationDestinyId
string <uuid>
opcional
Location Destiny Id
initialDate
string <date-time>
opcional
Initial Date
finalDate
string <date-time>
opcional
Final Date
eventId
string <uuid>
opcional
Event Id
statuses
array[string]
opcional
Maneuver Statuses
Valores permitidos:
StartedFinishedCanceled
page
integer <int32>
opcional
Actual page number
Exemplo:
1
pageSize
integer <int32>
opcional
Items per page
Exemplo:
10
Parâmetros Header
x-tenant
requerido
Tenant identification

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://apis.qa01.hbsa.com.br/navigation/v1/maneuvers' \
--header 'x-tenant;'

Respostas

🟢200Success
application/json
Body
next
boolean 
opcional
estimatedCount
integer <int64> | null 
read-onlyopcional
items
array[object (ManeuverDto) {16}]  | null 
opcional
id
string <uuid>
opcional
assetId
string <uuid>
opcional
asset
null  | allOf {1} 
opcional
locationOriginId
string <uuid>
opcional
locationOrigin
null  | allOf {1} 
opcional
locationDestinyId
string <uuid>
opcional
locationDestiny
null  | allOf {1} 
opcional
status
enum<string> 
opcional
Valores permitidos:
StartedFinishedCanceled
initialDate
string <date-time>
opcional
finalDate
string <date-time> | null 
opcional
eventId
string <uuid>
opcional
event
null  | allOf {1} 
opcional
comandante
string  | null 
opcional
description
string  | null 
opcional
barges
array[object (ManeuverBargeDto) {3}]  | null 
opcional
restrictions
array[object (ManeuverRestrictionDto) {3}]  | null 
opcional
Exemplo
{
    "next": true,
    "estimatedCount": 0,
    "items": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
            "asset": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "plant": "string",
                "name": "string",
                "assetClassId": "612ce5f5-12bc-4349-bd22-8eec5b4bdcd6",
                "assetClass": {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "assetType": "Barge",
                    "name": "string"
                },
                "flag": "string",
                "registration": "string",
                "sapKey": 0,
                "idAutotrac": 0,
                "irin": "string",
                "callSign": "string",
                "mmsi": 0,
                "third": true,
                "minCrew": 0,
                "maxCrew": 0,
                "model": "Jumbo",
                "power": 0,
                "powerUnit": "string",
                "cover": true,
                "length": 0,
                "width": 0,
                "height": 0,
                "maxDraft": 0,
                "trb": 0,
                "trn": 0,
                "freeBoard": 0,
                "createdAt": "2019-08-24T14:15:22Z",
                "modifiedAt": "2019-08-24T14:15:22Z"
            },
            "locationOriginId": "09c716d4-7bd1-4930-9338-8a865bed2fa2",
            "locationOrigin": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "description": "string",
                "km": 0,
                "latitude": 0,
                "longitude": 0,
                "abbreviation": "string",
                "country": "string",
                "waterway": "River",
                "type": "Porto",
                "createdAt": "2019-08-24T14:15:22Z",
                "modifiedAt": "2019-08-24T14:15:22Z"
            },
            "locationDestinyId": "a23fc17d-8495-495e-b0d1-41e5825b0fbd",
            "locationDestiny": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "description": "string",
                "km": 0,
                "latitude": 0,
                "longitude": 0,
                "abbreviation": "string",
                "country": "string",
                "waterway": "River",
                "type": "Porto",
                "createdAt": "2019-08-24T14:15:22Z",
                "modifiedAt": "2019-08-24T14:15:22Z"
            },
            "status": "Started",
            "initialDate": "2019-08-24T14:15:22Z",
            "finalDate": "2019-08-24T14:15:22Z",
            "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",
            "event": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "eventName": "string"
            },
            "comandante": "string",
            "description": "string",
            "barges": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "maneuverId": "05db1572-76f3-44b7-a5b9-932143479228",
                    "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8"
                }
            ],
            "restrictions": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "maneuverID": "05fb8f2f-4add-490c-b65e-94debd605254",
                    "restriction": "Visibility"
                }
            ]
        }
    ]
}
🟠401Unauthorized - invalid or missing token
🟠403Forbidden
Modificado em 2024-07-12 15:41:46
Página anterior
List all Maneuvers Events by filter
Próxima página
Adds or updates a Maneuver
Built with