MergeHRISClient.Api.Employees.employees_retrieve

You're seeing just the function employees_retrieve, go back to MergeHRISClient.Api.Employees module for more information.
Link to this function

employees_retrieve(connection, authorization, x_account_token, id, opts \\ [])

View Source

Specs

employees_retrieve(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, MergeHRISClient.Model.Employee.t()} | {:error, Tesla.Env.t()}

Returns an Employee object with the given id.

Parameters

  • connection (MergeHRISClient.Connection): Connection to server
  • authorization (String.t): Should include 'Bearer ' followed by your production API Key.
  • x_account_token (String.t): Token identifying the end user.
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :expand (String.t): Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
    • :include_remote_data (boolean()): Whether to include the original data Merge fetched from the third-party to produce these models.
    • :include_sensitive_fields (boolean()): Whether to include sensetive fields (such as social security numbers) in the response.

      Returns

on success {:error, Tesla.Env.t} on failure