MergeHRISClient.Api.SyncStatus (MergeHRISClient v1.0.2) View Source

API calls for all endpoints tagged SyncStatus.

Link to this section Summary

Functions

Get syncing status. Possible values: DISABLED, DONE, FAILED, SYNCING

Link to this section Functions

Link to this function

sync_status_list(connection, authorization, x_account_token, opts \\ [])

View Source

Specs

Get syncing status. Possible values: DISABLED, DONE, FAILED, SYNCING

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.
  • opts (KeywordList): [optional] Optional parameters
    • :cursor (String.t): The pagination cursor value.
    • :page_size (integer()): Number of results to return per page.

      Returns

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