# Get Employee

Get an existing Employee, defined by their business_id.

Endpoint: GET /employee/{business_id}
Version: 1.27.2
Security: clientCredentials

## Path parameters:

  - `business_id` (string, required)
    The unique ID (business_id) used to create this Employee.

## Response 200 fields (application/json):

  - `business_id` (string, required)
    Unique identifier for this Employee.
    Example: "employee-42"

  - `name` (object)
    The name of this Employee. Both properties are nullable to allow for regional differences.

  - `name.first_name` (string)
    The given name of this Employee.
    Example: "Jan"

  - `name.last_name` (string)
    The surname of this Employee.
    Example: "Van den Berghe"

  - `driver_skills` (array)
    driver_skills are only meaningful in relation to a linked TransportResource. They are skills of the Employee that determine the feasibility of
a ResourceCombination and the resulting capabilities of this ResourceCombination.
    Example: ["digital side mirrors","driving license D"]

  - `skills` (array)
    skills are inherent to the Employee regardless of the vehicle they are operating, such as language skills. They are available to the ResourceCombination, 
regardless of the linked TransportResource.
    Example: ["Dutch","English"]

  - `start_location` (object)
    An ad-hoc location from which this Employee will start each work shift, unless otherwise specified on more specific entities. When using an ad-hoc 
location, the Employee will only be assigned to TransportResources with a matching start_location (name-based match).

Either address information or geo point must be provided. Resolved address information will be read only and be filled out after resolving. 

Either a home_base or a start_location must be provided.

  - `start_location.name` (string, required)
    A name by which to identify this location. If used as a start_location, this is used for matching colocated entities.
    Example: "Conundra"

  - `start_location.address_line` (string)
    The address line of this location's address. Can contain street, house number, bus and more.
    Example: "Voordries 41b"

  - `start_location.city` (string)
    The name of the locality of this location.

Required when no geo_point is provided.
    Example: "Oosterzele"

  - `start_location.zip_code` (string)
    The ZIP code of the locality of this location.

Required when no geo_point is provided.
    Example: "9860"

  - `start_location.country_code` (string)
    The ISO3166-1 alpha-2 two letter country code for this location.

Required when no geo_point is provided.

  - `start_location.geo_point` (object)

  - `start_location.geo_point.latitude` (number, required)
    Example: 50.9514048

  - `start_location.geo_point.longitude` (number, required)
    Example: 3.8067878

  - `start_location.geo_point.resolved` (object)
    Indicates whether the address is resolved.

  - `start_location.geo_point.resolved.geocoded` (boolean)
    Example: true

  - `start_location.geo_point.resolved.address` (string)
    Example: "Voordries 31 bus B, 9860 Oosterzele"

  - `start_location.geo_point.resolved.precision` (integer)
    Example: 9

  - `home_base` (object)
    The business_id of a known HomeBase in the system. This represents the location from which this Employee will start each work shift, unless otherwise 
specified on more specific entities. When located at a HomeBase, the Employee will only be assigned to TransportResources with a matching home_base. 
This is conceptually the same as using an ad-hoc start_location, but with centralized address management which automatically propagates changes on the 
root entity.

Either a home_base or a start_location must be provided.

  - `home_base.business_id` (string, required)
    The unique identifier of a HomeBase.
    Example: "depot-1"

  - `linked_resource` (string)
    A reference to the TransportResource (by business_id) which should be linked to this Employee if possible. The algorithm will try to adhere to 
this requirement as much as possible, but this may not be possible in case of:  
* differing start_location/home_base
* conflicting linked_resource on another Employee with overlapping availabilities
* unavailability of the TransportResource.
    Example: "0-ABC-123"

  - `wont_do` (array)
    Allows you to control the capabilities of a ResourceCombination for this Employee. This property can be used to disable a TransportResource's 
capabilities.

A use case could be disabling one type of cargo due. Suppose the Employee is unable to handle the _big bag_ cargo type, but you chose to define cargo 
types as capabilities on the TransportResource, you can add _big bag_ to this Employee's won't do.
    Example: ["big bag"]

  - `cost` (object)
    Costs associated with this Employee, which will be combined with assigned TransportResources in the resulting ResourceCombination. These costs
help steer the optimization algorithm towards an optimal solution.

The addition of costs maintains a precision of 4.

  - `cost.per_kilometer` (number)
    A cost to be applied per kilometer in the optimization when utilizing this resource.
    Example: 0.9

  - `cost.per_hour` (number)
    An hourly cost to be applied in the optimization when utilizing this resource.
    Example: 46.8

  - `cost.fixed` (number)
    The fixed cost to be applied in the optimization when utilizing this resource.
    Example: 213

  - `labels` (array)
    Labels provided by the Employee to its ResourceCombination. Using labels allows you to select subsets of ResourceCombinations for use in an 
optimization by configuring them in the _Resource Filter_.
    Example: ["Employee-label-A"]

  - `route_settings` (object)
    [EXPERIMENTAL] Various properties that will have an impact on the planning of a route in PTV OptiFlow.

  - `route_settings.driving_speed_factor` (number)
    [EXPERIMENTAL] This is the factor by which the default speed of the resulting ResourceCombination gets multiplied.

A use case could be a learning driver that might drive 10% slower than his/her colleagues. Setting the driving_speed_factor to 0.90 ensures the optimization algorithm takes this into account.
    Example: 1.25

  - `route_settings.max_stops_per_shift` (integer)
    [EXPERIMENTAL] This will affect the maximum number of stops an Employee will get planned for in PTV OptiFlow.

Use this property to ensure that drivers don't get assigned too many stops.
    Example: 3

  - `custom_data` (object)
    Custom data is an extendable hashmap of key-value pairs for client usage. These values have no meaning in the context of Resource Management, but can be used to 
enrich the data in OptiFlow with relevant information for the end users.    

Keys should not be blank nor contain periods.

## Response 404 fields (application/problem+json):

  - `title` (string)
    A short, summary of the problem.
    Example: "Validation exception"

  - `detail` (string)
    A detailed explanation specific to this problem.
    Example: "The field contains invalid business formatting."


## Response 401 fields