HBSA Internal
  1. Travels
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
        • Adds or updates a Maneuver
        • Get Maneuver Restrictions
        • Finds a maneuver by its identification
      • 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
          GET
        • Adds a new Travel
          POST
        • Partially updates a Travel
          PATCH
        • Finds a Travel by its identification
          GET
        • Deletes a Travel by its identification
          DELETE
        • Lists all LoadUnloads
          GET
        • Adds a new LoadUnload
          POST
        • Finds a LoadUnload by its identification
          GET
        • Partially updates a LoadUnload
          PATCH
        • Deletes a LoadUnload by its identification
          DELETE
        • Lists all TravelStretches
          GET
        • Adds a new TravelStretch
          POST
        • Finds a TravelStretch by its identification
          GET
        • Partially updates a TravelStretch
          PATCH
        • Deletes a TravelStretch by its identification
          DELETE
        • Lists all TravelStretchAttributes
          GET
        • Adds a new TravelStretchAttributes
          POST
        • Finds a TravelStretchAttributes by its identification
          GET
        • Partially updates a TravelStretchAttributes
          PATCH
        • Deletes a TravelStretchAttributes by its identification
          DELETE
        • Lists all StretchPushers
          GET
        • Adds a new StretchPusher
          POST
        • Finds a StretchPusher by its identification
          GET
        • Partially updates a StretchPusher
          PATCH
        • Deletes a StretchPusher by its identification
          DELETE
        • Lists all PusherBarges
          GET
        • Adds a new PusherBarge
          POST
        • Finds a PusherBarge by its identification
          GET
        • Partially updates a PusherBarge
          PATCH
        • Deletes a PusherBarge by its identification
          DELETE
  1. Travels

Adds a new Travel

Amb. de testes
https://apis.qa01.hbsa.com.br/navigation
Amb. de testes
https://apis.qa01.hbsa.com.br/navigation
POST
/v1/travels

Requisição

Parâmetros Header
x-tenant
requerido
Tenant identification
Parâmetros Bodyapplication/json
clientNumber
string  | null 
opcional
clientName
string  | null 
opcional
previousTravelId
string <uuid> | null 
opcional
routeId
string <uuid>
opcional
planInitialDate
string <date-time>
opcional
planFinalDate
string <date-time>
opcional
actualInitialDate
string <date-time> | null 
opcional
actualFinalDate
string <date-time> | null 
opcional
Exemplo
{
    "clientNumber": "string",
    "clientName": "string",
    "previousTravelId": "7bfe4514-ef12-456e-9111-53302d9e155c",
    "routeId": "fef0741a-9185-417e-be48-b4fe23a36919",
    "planInitialDate": "2019-08-24T14:15:22Z",
    "planFinalDate": "2019-08-24T14:15:22Z",
    "actualInitialDate": "2019-08-24T14:15:22Z",
    "actualFinalDate": "2019-08-24T14:15:22Z"
}

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 POST 'https://apis.qa01.hbsa.com.br/navigation/v1/travels' \
--header 'x-tenant;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientNumber": "string",
    "clientName": "string",
    "previousTravelId": "7bfe4514-ef12-456e-9111-53302d9e155c",
    "routeId": "fef0741a-9185-417e-be48-b4fe23a36919",
    "planInitialDate": "2019-08-24T14:15:22Z",
    "planFinalDate": "2019-08-24T14:15:22Z",
    "actualInitialDate": "2019-08-24T14:15:22Z",
    "actualFinalDate": "2019-08-24T14:15:22Z"
}'

Respostas

🟢201Created
application/json
Body
id
string <uuid>
opcional
Exemplo
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠422Client Error
Modificado em 2024-07-12 15:41:46
Página anterior
Lists all Travels
Próxima página
Partially updates a Travel
Built with