Skip to content

Latest commit

 

History

History
82 lines (61 loc) · 2.81 KB

SyncStatusApi.md

File metadata and controls

82 lines (61 loc) · 2.81 KB

SyncStatusApi

All URIs are relative to https://api.merge.dev/api/hris/v1

Method HTTP request Description
syncStatusList GET /sync-status

syncStatusList

PaginatedSyncStatusList syncStatusList(xAccountToken, cursor, pageSize)

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

Example

// Import classes:
import merge_hris_client.ApiClient;
import merge_hris_client.ApiException;
import merge_hris_client.Configuration;
import merge_hris_client.auth.*;
import merge_hris_client.models.*;
import merge_hris_client.api.SyncStatusApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.merge.dev/api/hris/v1");
    
    // Configure API key authorization: tokenAuth
    ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
    tokenAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //tokenAuth.setApiKeyPrefix("Token");

    SyncStatusApi apiInstance = new SyncStatusApi(defaultClient);
    String xAccountToken = "xAccountToken_example"; // String | Token identifying the end user.
    String cursor = "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"; // String | The pagination cursor value.
    Integer pageSize = 56; // Integer | Number of results to return per page.
    try {
      PaginatedSyncStatusList result = apiInstance.syncStatusList(xAccountToken, cursor, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SyncStatusApi#syncStatusList");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
xAccountToken String Token identifying the end user.
cursor String The pagination cursor value. [optional]
pageSize Integer Number of results to return per page. [optional]

Return type

PaginatedSyncStatusList

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -