HBSA Internal
  1. Employees
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
          GET
        • Adds a new Employees
          POST
        • Finds a Employees by its identification
          GET
        • Partially updates a Employees
          PATCH
        • Deletes a Employees by its identification
          DELETE
      • 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
        • 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. Employees

Partially updates a Employees

Amb. de testes
https://apis.qa01.hbsa.com.br/navigation
Amb. de testes
https://apis.qa01.hbsa.com.br/navigation
PATCH
/v1/employees/{id}

Requisição

Parâmetros Path
id
string <uuid>
requerido
Identification
Parâmetros Header
x-tenant
requerido
Tenant identification
Parâmetros Bodyapplication/json
contractResolver
null  | allOf {1} 
opcional
object (IContractResolver) 
opcional
Exemplo
[
    {
        "op": "replace",
        "path": "/Company",
        "value": "Company Name"
    },
    {
        "op": "replace",
        "path": "/EmployeeCode",
        "value": "100"
    },
    {
        "op": "replace",
        "path": "/Name",
        "value": "Name of Employee"
    },
    {
        "op": "replace",
        "path": "/CPF",
        "value": "97474919079"
    },
    {
        "op": "replace",
        "path": "/AdmissionDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/PhoneNumber",
        "value": "9999999999999"
    },
    {
        "op": "replace",
        "path": "/Email",
        "value": "test@test.com"
    },
    {
        "op": "replace",
        "path": "/OriginalFunctionCode",
        "value": "100"
    },
    {
        "op": "replace",
        "path": "/OriginalFunctionName",
        "value": "Function xpto"
    },
    {
        "op": "replace",
        "path": "/Situation",
        "value": "true"
    },
    {
        "op": "replace",
        "path": "/Dismissed",
        "value": "true"
    },
    {
        "op": "replace",
        "path": "/ResignationDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/VacationInitialDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/VacationFinalDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/WorkLeavingDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/WorkReturningDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/WorkLeavingReason",
        "value": "Reason xpto"
    },
    {
        "op": "replace",
        "path": "/NavDocNumber",
        "value": "0123456789"
    },
    {
        "op": "replace",
        "path": "/NavDocExpDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/SlackBalance",
        "value": "123"
    },
    {
        "op": "replace",
        "path": "/BlockReason",
        "value": "Block Reason xpto"
    }
]

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 PATCH 'https://apis.qa01.hbsa.com.br/navigation/v1/employees/' \
--header 'x-tenant;' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "op": "replace",
        "path": "/Company",
        "value": "Company Name"
    },
    {
        "op": "replace",
        "path": "/EmployeeCode",
        "value": "100"
    },
    {
        "op": "replace",
        "path": "/Name",
        "value": "Name of Employee"
    },
    {
        "op": "replace",
        "path": "/CPF",
        "value": "97474919079"
    },
    {
        "op": "replace",
        "path": "/AdmissionDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/PhoneNumber",
        "value": "9999999999999"
    },
    {
        "op": "replace",
        "path": "/Email",
        "value": "test@test.com"
    },
    {
        "op": "replace",
        "path": "/OriginalFunctionCode",
        "value": "100"
    },
    {
        "op": "replace",
        "path": "/OriginalFunctionName",
        "value": "Function xpto"
    },
    {
        "op": "replace",
        "path": "/Situation",
        "value": "true"
    },
    {
        "op": "replace",
        "path": "/Dismissed",
        "value": "true"
    },
    {
        "op": "replace",
        "path": "/ResignationDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/VacationInitialDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/VacationFinalDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/WorkLeavingDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/WorkReturningDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/WorkLeavingReason",
        "value": "Reason xpto"
    },
    {
        "op": "replace",
        "path": "/NavDocNumber",
        "value": "0123456789"
    },
    {
        "op": "replace",
        "path": "/NavDocExpDate",
        "value": "2023-01-01T00:00:00.000Z"
    },
    {
        "op": "replace",
        "path": "/SlackBalance",
        "value": "123"
    },
    {
        "op": "replace",
        "path": "/BlockReason",
        "value": "Block Reason xpto"
    }
]'

Respostas

🟢204No Content
application/json
Body
object {0}
Exemplo
{}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠422Client Error
Modificado em 2024-07-12 15:41:46
Página anterior
Finds a Employees by its identification
Próxima página
Deletes a Employees by its identification
Built with