All URIs are relative to https://unify.apideck.com
| Method | HTTP request | Description |
|---|---|---|
| CompaniesAdd | POST /hris/companies | Create Company |
| CompaniesAll | GET /hris/companies | List Companies |
| CompaniesDelete | DELETE /hris/companies/{id} | Delete Company |
| CompaniesOne | GET /hris/companies/{id} | Get Company |
| CompaniesUpdate | PATCH /hris/companies/{id} | Update Company |
| DepartmentsAdd | POST /hris/departments | Create Department |
| DepartmentsAll | GET /hris/departments | List Departments |
| DepartmentsDelete | DELETE /hris/departments/{id} | Delete Department |
| DepartmentsOne | GET /hris/departments/{id} | Get Department |
| DepartmentsUpdate | PATCH /hris/departments/{id} | Update Department |
| EmployeePayrollsAll | GET /hris/payrolls/employees/{employee_id} | List Employee Payrolls |
| EmployeePayrollsOne | GET /hris/payrolls/employees/{employee_id}/payrolls/{payroll_id} | Get Employee Payroll |
| EmployeeSchedulesAll | GET /hris/schedules/employees/{employee_id} | List Employee Schedules |
| EmployeesAdd | POST /hris/employees | Create Employee |
| EmployeesAll | GET /hris/employees | List Employees |
| EmployeesDelete | DELETE /hris/employees/{id} | Delete Employee |
| EmployeesOne | GET /hris/employees/{id} | Get Employee |
| EmployeesUpdate | PATCH /hris/employees/{id} | Update Employee |
| PayrollsAll | GET /hris/payrolls | List Payroll |
| PayrollsOne | GET /hris/payrolls/{payroll_id} | Get Payroll |
| TimeOffRequestsAdd | POST /hris/time-off-requests | Create Time Off Request |
| TimeOffRequestsAll | GET /hris/time-off-requests | List Time Off Requests |
| TimeOffRequestsDelete | DELETE /hris/time-off-requests/employees/{employee_id}/time-off-requests/{id} | Delete Time Off Request |
| TimeOffRequestsOne | GET /hris/time-off-requests/employees/{employee_id}/time-off-requests/{id} | Get Time Off Request |
| TimeOffRequestsUpdate | PATCH /hris/time-off-requests/employees/{employee_id}/time-off-requests/{id} | Update Time Off Request |
CreateHrisCompanyResponse CompaniesAdd (HrisCompany hrisCompany, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)
Create Company
Create Company
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class CompaniesAddExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var hrisCompany = new HrisCompany(); // HrisCompany |
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
try
{
// Create Company
CreateHrisCompanyResponse result = apiInstance.CompaniesAdd(hrisCompany, raw, consumerId, appId, serviceId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.CompaniesAdd: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| hrisCompany | HrisCompany | ||
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Companies | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetHrisCompaniesResponse CompaniesAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, PassThroughQuery passThrough = null, string fields = null)
List Companies
List Companies
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class CompaniesAllExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var cursor = "cursor_example"; // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional)
var limit = 20; // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional) (default to 20)
var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// List Companies
GetHrisCompaniesResponse result = apiInstance.CompaniesAll(raw, consumerId, appId, serviceId, cursor, limit, passThrough, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.CompaniesAll: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| cursor | string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] |
| limit | int? | Number of results to return. Minimum 1, Maximum 200, Default 20 | [optional] [default to 20] |
| passThrough | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Companies | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteHrisCompanyResponse CompaniesDelete (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)
Delete Company
Delete Company
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class CompaniesDeleteExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
try
{
// Delete Company
DeleteHrisCompanyResponse result = apiInstance.CompaniesDelete(id, consumerId, appId, serviceId, raw);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.CompaniesDelete: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Companies | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetHrisCompanyResponse CompaniesOne (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null)
Get Company
Get Company
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class CompaniesOneExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// Get Company
GetHrisCompanyResponse result = apiInstance.CompaniesOne(id, consumerId, appId, serviceId, raw, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.CompaniesOne: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Company | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateHrisCompanyResponse CompaniesUpdate (string id, HrisCompany hrisCompany, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)
Update Company
Update Company
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class CompaniesUpdateExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var hrisCompany = new HrisCompany(); // HrisCompany |
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
try
{
// Update Company
UpdateHrisCompanyResponse result = apiInstance.CompaniesUpdate(id, hrisCompany, consumerId, appId, serviceId, raw);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.CompaniesUpdate: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| hrisCompany | HrisCompany | ||
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Companies | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateDepartmentResponse DepartmentsAdd (Department department, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)
Create Department
Create Department
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class DepartmentsAddExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var department = new Department(); // Department |
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
try
{
// Create Department
CreateDepartmentResponse result = apiInstance.DepartmentsAdd(department, raw, consumerId, appId, serviceId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.DepartmentsAdd: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| department | Department | ||
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Departments | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetDepartmentsResponse DepartmentsAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, PassThroughQuery passThrough = null, string fields = null)
List Departments
List Departments
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class DepartmentsAllExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var cursor = "cursor_example"; // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional)
var limit = 20; // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional) (default to 20)
var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// List Departments
GetDepartmentsResponse result = apiInstance.DepartmentsAll(raw, consumerId, appId, serviceId, cursor, limit, passThrough, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.DepartmentsAll: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| cursor | string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] |
| limit | int? | Number of results to return. Minimum 1, Maximum 200, Default 20 | [optional] [default to 20] |
| passThrough | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Departments | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteDepartmentResponse DepartmentsDelete (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)
Delete Department
Delete Department
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class DepartmentsDeleteExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
try
{
// Delete Department
DeleteDepartmentResponse result = apiInstance.DepartmentsDelete(id, consumerId, appId, serviceId, raw);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.DepartmentsDelete: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Departments | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetDepartmentResponse DepartmentsOne (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null)
Get Department
Get Department
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class DepartmentsOneExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// Get Department
GetDepartmentResponse result = apiInstance.DepartmentsOne(id, consumerId, appId, serviceId, raw, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.DepartmentsOne: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Departments | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateDepartmentResponse DepartmentsUpdate (string id, Department department, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)
Update Department
Update Department
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class DepartmentsUpdateExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var department = new Department(); // Department |
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
try
{
// Update Department
UpdateDepartmentResponse result = apiInstance.DepartmentsUpdate(id, department, consumerId, appId, serviceId, raw);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.DepartmentsUpdate: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| department | Department | ||
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Departments | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEmployeePayrollsResponse EmployeePayrollsAll (string employeeId, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, PayrollsFilter filter = null, PassThroughQuery passThrough = null, string fields = null)
List Employee Payrolls
List payrolls for employee
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class EmployeePayrollsAllExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var employeeId = "employeeId_example"; // string | ID of the employee you are acting upon.
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var filter = new PayrollsFilter(); // PayrollsFilter | Apply filters (optional)
var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// List Employee Payrolls
GetEmployeePayrollsResponse result = apiInstance.EmployeePayrollsAll(employeeId, raw, consumerId, appId, serviceId, filter, passThrough, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.EmployeePayrollsAll: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| employeeId | string | ID of the employee you are acting upon. | |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| filter | PayrollsFilter | Apply filters | [optional] |
| passThrough | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | EmployeePayrolls | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEmployeePayrollResponse EmployeePayrollsOne (string payrollId, string employeeId, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string fields = null)
Get Employee Payroll
Get payroll for employee
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class EmployeePayrollsOneExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var payrollId = "payrollId_example"; // string | ID of the payroll you are acting upon.
var employeeId = "employeeId_example"; // string | ID of the employee you are acting upon.
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// Get Employee Payroll
GetEmployeePayrollResponse result = apiInstance.EmployeePayrollsOne(payrollId, employeeId, raw, consumerId, appId, serviceId, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.EmployeePayrollsOne: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| payrollId | string | ID of the payroll you are acting upon. | |
| employeeId | string | ID of the employee you are acting upon. | |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Payrolls | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEmployeeSchedulesResponse EmployeeSchedulesAll (string employeeId, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, PassThroughQuery passThrough = null, string fields = null)
List Employee Schedules
List schedules for employee, a schedule is a work pattern, not the actual worked hours, for an employee.
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class EmployeeSchedulesAllExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var employeeId = "employeeId_example"; // string | ID of the employee you are acting upon.
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// List Employee Schedules
GetEmployeeSchedulesResponse result = apiInstance.EmployeeSchedulesAll(employeeId, raw, consumerId, appId, serviceId, passThrough, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.EmployeeSchedulesAll: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| employeeId | string | ID of the employee you are acting upon. | |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| passThrough | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | EmployeeSchedules | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateEmployeeResponse EmployeesAdd (Employee employee, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)
Create Employee
Create Employee
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class EmployeesAddExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var employee = new Employee(); // Employee |
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
try
{
// Create Employee
CreateEmployeeResponse result = apiInstance.EmployeesAdd(employee, raw, consumerId, appId, serviceId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.EmployeesAdd: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| employee | Employee | ||
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Employees | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEmployeesResponse EmployeesAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, EmployeesFilter filter = null, EmployeesSort sort = null, PassThroughQuery passThrough = null, string fields = null)
List Employees
Apideck operates as a stateless Unified API, which means that the list endpoint only provides a portion of the employee model. This is due to the fact that most HRIS systems do not readily provide all data in every call. However, you can access the complete employee model through an employee detail call.
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class EmployeesAllExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var cursor = "cursor_example"; // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional)
var limit = 20; // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional) (default to 20)
var filter = new EmployeesFilter(); // EmployeesFilter | Apply filters (optional)
var sort = new EmployeesSort(); // EmployeesSort | Apply sorting (optional)
var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// List Employees
GetEmployeesResponse result = apiInstance.EmployeesAll(raw, consumerId, appId, serviceId, cursor, limit, filter, sort, passThrough, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.EmployeesAll: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| cursor | string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] |
| limit | int? | Number of results to return. Minimum 1, Maximum 200, Default 20 | [optional] [default to 20] |
| filter | EmployeesFilter | Apply filters | [optional] |
| sort | EmployeesSort | Apply sorting | [optional] |
| passThrough | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Employees | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteEmployeeResponse EmployeesDelete (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)
Delete Employee
Delete Employee
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class EmployeesDeleteExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
try
{
// Delete Employee
DeleteEmployeeResponse result = apiInstance.EmployeesDelete(id, consumerId, appId, serviceId, raw);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.EmployeesDelete: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Employees | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEmployeeResponse EmployeesOne (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null, EmployeesOneFilter filter = null, PassThroughQuery passThrough = null)
Get Employee
Get Employee
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class EmployeesOneExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
var filter = new EmployeesOneFilter(); // EmployeesOneFilter | Apply filters (optional)
var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
try
{
// Get Employee
GetEmployeeResponse result = apiInstance.EmployeesOne(id, consumerId, appId, serviceId, raw, fields, filter, passThrough);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.EmployeesOne: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
| filter | EmployeesOneFilter | Apply filters | [optional] |
| passThrough | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Employees | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateEmployeeResponse EmployeesUpdate (string id, Employee employee, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)
Update Employee
Update Employee
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class EmployeesUpdateExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var employee = new Employee(); // Employee |
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
try
{
// Update Employee
UpdateEmployeeResponse result = apiInstance.EmployeesUpdate(id, employee, consumerId, appId, serviceId, raw);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.EmployeesUpdate: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| employee | Employee | ||
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Employees | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPayrollsResponse PayrollsAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, PayrollsFilter filter = null, PassThroughQuery passThrough = null, string fields = null)
List Payroll
List Payroll
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class PayrollsAllExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var filter = new PayrollsFilter(); // PayrollsFilter | Apply filters (optional)
var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// List Payroll
GetPayrollsResponse result = apiInstance.PayrollsAll(raw, consumerId, appId, serviceId, filter, passThrough, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.PayrollsAll: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| filter | PayrollsFilter | Apply filters | [optional] |
| passThrough | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Payrolls | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPayrollResponse PayrollsOne (string payrollId, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string fields = null)
Get Payroll
Get Payroll
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class PayrollsOneExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var payrollId = "payrollId_example"; // string | ID of the payroll you are acting upon.
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// Get Payroll
GetPayrollResponse result = apiInstance.PayrollsOne(payrollId, raw, consumerId, appId, serviceId, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.PayrollsOne: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| payrollId | string | ID of the payroll you are acting upon. | |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Payrolls | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateTimeOffRequestResponse TimeOffRequestsAdd (TimeOffRequest timeOffRequest, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)
Create Time Off Request
Create Time Off Request
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class TimeOffRequestsAddExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var timeOffRequest = new TimeOffRequest(); // TimeOffRequest |
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
try
{
// Create Time Off Request
CreateTimeOffRequestResponse result = apiInstance.TimeOffRequestsAdd(timeOffRequest, raw, consumerId, appId, serviceId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.TimeOffRequestsAdd: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| timeOffRequest | TimeOffRequest | ||
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | TimeOffRequests | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTimeOffRequestsResponse TimeOffRequestsAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, TimeOffRequestsFilter filter = null, PassThroughQuery passThrough = null, string fields = null)
List Time Off Requests
List Time Off Requests
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class TimeOffRequestsAllExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var cursor = "cursor_example"; // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional)
var limit = 20; // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional) (default to 20)
var filter = new TimeOffRequestsFilter(); // TimeOffRequestsFilter | Apply filters (optional)
var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// List Time Off Requests
GetTimeOffRequestsResponse result = apiInstance.TimeOffRequestsAll(raw, consumerId, appId, serviceId, cursor, limit, filter, passThrough, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.TimeOffRequestsAll: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| cursor | string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] |
| limit | int? | Number of results to return. Minimum 1, Maximum 200, Default 20 | [optional] [default to 20] |
| filter | TimeOffRequestsFilter | Apply filters | [optional] |
| passThrough | PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | [optional] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | TimeOffRequests | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteTimeOffRequestResponse TimeOffRequestsDelete (string id, string employeeId, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)
Delete Time Off Request
Delete Time Off Request
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class TimeOffRequestsDeleteExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var employeeId = "employeeId_example"; // string | ID of the employee you are acting upon.
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
try
{
// Delete Time Off Request
DeleteTimeOffRequestResponse result = apiInstance.TimeOffRequestsDelete(id, employeeId, consumerId, appId, serviceId, raw);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.TimeOffRequestsDelete: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| employeeId | string | ID of the employee you are acting upon. | |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | TimeOffRequests | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTimeOffRequestResponse TimeOffRequestsOne (string id, string employeeId, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null)
Get Time Off Request
Get Time Off Request
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class TimeOffRequestsOneExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var employeeId = "employeeId_example"; // string | ID of the employee you are acting upon.
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
var fields = id,updated_at; // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
try
{
// Get Time Off Request
GetTimeOffRequestResponse result = apiInstance.TimeOffRequestsOne(id, employeeId, consumerId, appId, serviceId, raw, fields);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.TimeOffRequestsOne: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| employeeId | string | ID of the employee you are acting upon. | |
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
| fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | TimeOffRequests | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateTimeOffRequestResponse TimeOffRequestsUpdate (string id, string employeeId, TimeOffRequest timeOffRequest, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)
Update Time Off Request
Update Time Off Request
using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;
namespace Example
{
public class TimeOffRequestsUpdateExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://unify.apideck.com";
// Configure API key authorization: apiKey
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HrisApi(config);
var id = "id_example"; // string | ID of the record you are acting upon.
var employeeId = "employeeId_example"; // string | ID of the employee you are acting upon.
var timeOffRequest = new TimeOffRequest(); // TimeOffRequest |
var consumerId = "consumerId_example"; // string | ID of the consumer which you want to get or push data from (optional)
var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX; // string | The ID of your Unify application (optional)
var serviceId = "serviceId_example"; // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
var raw = false; // bool? | Include raw response. Mostly used for debugging purposes (optional) (default to false)
try
{
// Update Time Off Request
UpdateTimeOffRequestResponse result = apiInstance.TimeOffRequestsUpdate(id, employeeId, timeOffRequest, consumerId, appId, serviceId, raw);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling HrisApi.TimeOffRequestsUpdate: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| employeeId | string | ID of the employee you are acting upon. | |
| timeOffRequest | TimeOffRequest | ||
| consumerId | string | ID of the consumer which you want to get or push data from | [optional] |
| appId | string | The ID of your Unify application | [optional] |
| serviceId | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] |
| raw | bool? | Include raw response. Mostly used for debugging purposes | [optional] [default to false] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | TimeOffRequests | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 402 | Payment Required | - |
| 404 | The specified resource was not found | - |
| 422 | Unprocessable | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]