Clay HR API Integration

These are the list of integration use cases supported by Knit for Clay HR API as part of the HRIS category

Delete Goal

ID: delete_goal
Operation: write
Entities: user, goal, api key
Summary: The Delete Goal API allows users to delete a specific goal by providing the goalId as a query parameter. The request requires authentication through the x-api-key and userId headers. If the operation is successful, a message 'Success' is returned. If the authentication fails, a 401 error with the message 'Access denied! Either Authorization or x-api-key & userid parameters are not present/valid.' is returned. If the user does not have permission to delete the goal, a 403 error with the message 'You do not have the permission to delete this goal.' is returned. If the goal is not found, a 404 error with the message 'Goal not found.' is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get Access Token for Authentication

ID: get_access_token_for_authentication
Operation: read
Entities: user, access token
Summary: This API endpoint is used to obtain an access token for authentication purposes. It requires two headers: 'x-api-key', which is the API key of the user, and 'userid', which is the ID of the user. Both headers are mandatory. The API responds with a JSON object containing an 'accessToken' if the request is successful (HTTP 200). If the request is forbidden, it returns a message 'forbidden' (HTTP 403), and if there is a conflict, it returns a message 'failure' (HTTP 409).
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve All Active OrgRelations

ID: get_all_active_orgrelations
Operation: read
Entities: department, user, org relation
Summary: This API endpoint retrieves all active organizational relations (OrgRelations) for the entire organization. It requires authentication through headers, specifically 'x-api-key' and 'userid'. The response includes detailed information about each active OrgRelation, such as orgRelationId, userId, managerUserId, emails, relationType, dates, status, and detailed user models including department and location information. The API returns a 200 status with the data if successful, a 401 status if unauthorized, and a 409 status if there is a conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Survey Responses

ID: get_all_survey_responses
Operation: read
Entities: user, response, survey
Summary: The 'Get All Survey Responses' API endpoint allows users to retrieve all responses for a specific survey. The request requires authentication via a user ID and API key provided in the headers. An optional query parameter 'SurveyId' can be used to specify the survey for which responses are needed. The response includes a success status code and an array of responses, each containing details such as response ID, item ID, response text, creator user ID, creation timestamp, assignment ID, digital signature model, CID, remote address, grader response status, attachment model, sentiment code, sentiment score, answer correctness, and user ID. Error responses include authentication failure (401) and permission denial (403).
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve All Users Details API

ID: get_all_users_details
Operation: read
Entities: employees
Summary: The Retrieve All Users Details API allows you to fetch a list of all employees from the BizMerlinHR application. The API requires authentication using a 'userid' and 'x-api-key' in the headers. It supports various query parameters such as 'name', 'page', 'pageSize', 'search', 'startDateBefore', 'startDateAfter', 'endDateBefore', 'endDateAfter', and 'status' to filter the results. The response includes detailed information about each user, including their personal and employment details.
Input Fields: Input Fields
Output Fields: Output Fields

Get Announcement Details

ID: get_announcement_details
Operation: read
Entities: department, announcement, user
Summary: The Get Announcement Details API retrieves detailed information about a specific announcement identified by the 'annId' path parameter. The request requires authentication headers 'userid' and 'x-api-key'. The response includes comprehensive details about the announcement, such as its title, description, status, and associated user and department models. The API returns a 200 status code with the announcement details on success, and 401 or 409 status codes with a failure message if unauthorized.
Input Fields: Input Fields
Output Fields: Output Fields

Get Appraisal Assignment Details

ID: get_appraisal_assignment_details
Operation: read
Entities: assignment, appraisal, user
Summary: The Get Appraisal Assignment Details API retrieves detailed information about appraisal assignments. It requires authentication via headers, including 'userid' and 'x-api-key'. The response includes a comprehensive set of data about the appraisal assignment, such as assignment ID, appraisal ID, reviewer details, score templates, user models, and more. The response is structured in a JSON format with a 'code' indicating success or failure and a 'message' providing additional context.
Input Fields: Input Fields
Output Fields: Output Fields

Get Appraisal Template List

ID: get_appraisal_template_list
Operation: read
Entities: user, appraisal template, manager
Summary: The Get Appraisal Template List API retrieves a list of appraisal templates available in the system. It requires authentication through the 'userid' and 'x-api-key' headers. The response includes details of each appraisal template such as 'appraisalTemplateId', 'name', 'description', 'userId', 'startDate', 'endDate', 'cid', 'managerId', 'appraisalType', 'obType', 'createUserId', 'contributorId', 'scoreTemplateId', 'signatureFlowLibraryId', 'status', and 'processTemplateId'. The API returns a message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Get Attachment List by Announcement ID

ID: get_attachment_list_by_announcement_id
Operation: read
Entities: attachment, announcement, user
Summary: This API endpoint retrieves a list of attachments associated with a specific announcement ID. The request requires the 'annId' path parameter, which is the ID of the announcement, and two headers: 'userid' and 'x-api-key' for authentication. The response includes detailed information about each attachment, such as attachment ID, type, file extension, and associated user and project models. The response also contains user details, document types, and other metadata related to the attachments.
Input Fields: Input Fields
Output Fields: Output Fields

Get Basic User Information

ID: get_basic_user_information
Operation: read
Entities: user, authentication, job title
Summary: The Get Basic User Information API endpoint retrieves basic information about a user from the BizMerlinHR application. It requires the 'userid' and 'x-api-key' headers for authentication. The 'email' query parameter is optional, while the 'userID' query parameter is required. The response includes detailed user information such as userId, firstName, lastName, email, status, jobTitle, and more. A successful response returns a JSON object with these details, while an unauthorized request returns a 401 status with an 'Unauthorized' message.
Input Fields: Input Fields
Output Fields: Output Fields

Get Candidate Details

ID: get_candidate_details
Operation: read
Entities: position, recruiter, candidate
Summary: The Get Candidate Details API retrieves detailed information about a candidate using their recruiter ID. The API requires authentication through a user ID and an API key, both of which must be included in the request headers. The recruiter ID is a required path parameter. The response includes a comprehensive set of candidate details such as personal information, recruitment status, and various models related to employment, education, and skills. The API returns a successful message upon a 200 response, and error messages for 404 (not found) and 409 (failure) responses.
Input Fields: Input Fields
Output Fields: Output Fields

Get Candidate List

ID: get_candidate_list
Operation: read
Entities: position, recruiter, candidate
Summary: The Get Candidate List API retrieves a list of candidates from the BizMerlinHR system. It requires authentication via a user ID and API key provided in the headers. The API supports pagination through 'page' and 'pageSize' query parameters, and allows for optional search queries. The response includes detailed information about each candidate, such as their ID, name, email, phone number, and other relevant details. The API returns a successful message and edit permission status if the request is successful, or error messages for not found or failure cases.
Input Fields: Input Fields
Output Fields: Output Fields

Get Completed Appraisal Reviews

ID: get_completed_appraisal_reviews
Operation: read
Entities: user model, appraisal, department model
Summary: The Get Completed Appraisal Reviews API retrieves a list of completed appraisal reviews for a specified user. The API requires authentication via a user ID and an API key, both provided in the request headers. The target user's ID must be specified as a query parameter. The response includes detailed information about each completed appraisal, such as appraisal ID, name, description, user details, department information, and scoring details. The response is returned in JSON format, with a success message if the operation is successful.
Input Fields: Input Fields
Output Fields: Output Fields

Get Currency List

ID: get_currency_list
Operation: read
Entities: currency
Summary: The Get Currency List API endpoint retrieves a list of currencies available in the BizMerlinHR system. It requires authentication using a user ID and an API key, both of which must be included in the request headers. The API responds with a JSON object containing an array of currency objects, each with a currency ID, currency code, currency name, and a CID. The response also includes a message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Get Custom Field Values

ID: get_custom_field_values
Operation: read
Entities: custom field, authentication, user
Summary: The Get Custom Field Values API retrieves the values of custom fields for a specified user. It requires authentication via a user ID and an API key in the headers. The query parameters include 'customFieldCode', 'customFieldId', 'userId', 'userEmail', and 'empId'. The 'customFieldId' and 'userId' are mandatory parameters. The API returns a JSON object containing details such as 'customFieldValueId', 'customFieldId', 'customFieldObjectId', 'cid', 'createUserId', and 'customfieldName'. In case of authentication failure, a 401 error with a message is returned, and a 409 error is returned for other failures.
Input Fields: Input Fields
Output Fields: Output Fields

Get Custom Groups

ID: get_custom_groups
Operation: read
Entities: custom group
Summary: The Get Custom Groups API retrieves custom groups from the BizMerlin platform. It requires the 'objectId' and 'objectType' as query parameters, and 'userid' and 'x-api-key' as headers. The API returns a 200 OK response with an iterable object if successful. If unauthorized, forbidden, or not found, it returns 401, 403, or 404 errors respectively. The response may also include error messages related to stale element references.
Input Fields: Input Fields
Output Fields: Output Fields

Get Custom List

ID: get_custom_list
Operation: read
Entities: custom list, custom list entry model
Summary: The Get Custom List API endpoint retrieves a list of custom entries from the BizMerlin platform. It requires authentication via a user ID and an API key, both of which must be included in the request headers. The response is a JSON array containing objects that represent custom lists, each with a list ID, name, description, and a collection of entries. Each entry includes an entry ID, code, value, list ID, and a CID. The API returns a 200 status code with the list data on success, a 401 status code if authentication fails, and a 409 status code for other errors.
Input Fields: Input Fields
Output Fields: Output Fields

Get Document Library

ID: get_document_library
Operation: read
Entities: user, document, project
Summary: The Get Document Library API retrieves a list of documents from the document library. It requires authentication via a user ID and an API key, both of which must be included in the request headers. The response includes a code indicating success or failure, a data array containing detailed information about each document, and a message. Each document in the data array includes attributes such as attachid, atchType, fileExtn, s3id, filename, and many more, providing comprehensive details about the document.
Input Fields: Input Fields
Output Fields: Output Fields

Download Attachment

ID: get_download_attachment
Operation: read
Entities: user, file, attachment
Summary: The Download Attachment API allows users to download a file from the server using a GET request. The request requires the 'fileName' as a query parameter, which is the ID of the file to be downloaded. Additionally, the request must include 'userid' and 'x-api-key' in the headers for authentication purposes. The API returns a JSON response with a 'code', 'data', and 'message'. A successful response (200) will have a code of 1 and a message of 'successful'. If there is a conflict (409), the response will have a code of -1 and a message of 'failure'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Dynamic Form Details

ID: get_dynamic_form_details
Operation: read
Entities: user, section, form
Summary: This API endpoint retrieves the details of a dynamic form from the BizMerlinHR application. It requires the 'dynamicFormId' as a query parameter to specify which form to retrieve. The request must include 'userid' and 'x-api-key' in the headers for authentication. The response includes detailed information about the form, such as its name, description, sections, and items, along with user and form metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Get Dynamic Form Response

ID: get_dynamic_form_response
Operation: read
Entities: user, response, form
Summary: The Get Dynamic Form Response API retrieves the response data for a specific dynamic form identified by the dynamicFormId. It requires authentication using the userid and x-api-key headers. The API accepts optional query parameters assignUserId and assignmentId to filter the responses. The response includes detailed information about the form, its sections, items, and user responses, along with metadata such as creation timestamps and user details.
Input Fields: Input Fields
Output Fields: Output Fields

Get Dynamic Forms

ID: get_dynamic_forms
Operation: read
Entities: department, user, dynamic form
Summary: The Get Dynamic Forms API endpoint allows users to retrieve a list of dynamic forms available in the BizMerlinHR system. The request requires authentication via headers, specifically the 'userid' and 'x-api-key'. The response includes detailed information about each dynamic form, such as its ID, name, description, and associated user details. The API returns a 200 status code with the form data on success, or a 401 status code if authentication fails.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Expense Report Details

ID: get_expense_report_details
Operation: read
Entities: user, expense report, project
Summary: The Retrieve Expense Report Details API allows users to fetch the details of an expense report from the BizMerlinHR system. The API requires authentication via the 'userid' and 'x-api-key' headers. It accepts two optional query parameters: 'expenseReportId' and 'guid', which can be used individually or together to specify the expense report to retrieve. The response includes detailed information about the expense report, such as its ID, name, description, amount, status, and associated user details. The API returns a 200 status code with the expense report details on success, a 401 status code if the user lacks permission, and a 409 status code if an error occurs.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Expense Reports with User ID

ID: get_expense_reports_with_user_id
Operation: read
Entities: user, currency model, expense report
Summary: This API endpoint retrieves expense reports for a specified user ID. It requires authentication via headers 'userid' and 'x-api-key'. The API supports query parameters 'userID', 'guid', and 'email' to filter the expense reports. The response includes detailed information about each expense report, such as 'expenseReportId', 'name', 'description', 'amount', 'status', and 'currencyModel'. The API returns a 200 status code with the expense report data or a 401 status code if authentication fails.
Input Fields: Input Fields
Output Fields: Output Fields

Get Expense Types

ID: get_expense_types
Operation: read
Entities: user, expense type, custom field value
Summary: The Get Expense Types API retrieves a list of expense types available in the BizMerlinHR system. It requires authentication using a user ID and an API key, both of which must be included in the request headers. The response includes details about each expense type, such as its ID, code, description, and associated custom field values. The custom field values provide additional metadata about the expense types.
Input Fields: Input Fields
Output Fields: Output Fields

Get Goal Details

ID: get_goal_details
Operation: read
Entities: department, goal, user
Summary: The Get Goal Details API allows users to retrieve detailed information about a specific goal using its ID. The API requires authentication through headers 'x-api-key' and 'userId'. The 'goalid' query parameter is mandatory to specify which goal to retrieve. An optional 'reviewUserId' can be provided to specify the reviewee. The response includes comprehensive details about the goal, such as its summary, status, assigned user details, and collaboration information. The API returns a 200 status with goal details on success, a 401 status if authentication fails, and a 404 status if the goal is not found.
Input Fields: Input Fields
Output Fields: Output Fields

Get Invoice Details

ID: get_invoice_details
Operation: read
Entities: user, invoice, project
Summary: The Get Invoice Details API retrieves invoice information for a specified project. It requires authentication via a user ID and API key in the headers, and a project ID as a query parameter. The response includes detailed invoice data such as invoice ID, amount, description, project details, status, due date, and more. The response is returned in JSON format with a message indicating success.
Input Fields: Input Fields
Output Fields: Output Fields

Get Job Profiles

ID: get_job_profiles
Operation: read
Entities: user, job profile, manager
Summary: The Get Job Profiles API endpoint retrieves a list of job profiles from the BizMerlinHR system. It requires authentication via a user ID and API key, both of which must be included in the request headers. The API also requires a query parameter 'status' to filter job profiles by their status, which can be 'A' for Active, 'OPEN' for Open, or 'ARCHV' for Archive. The response is a JSON array of job profiles, each containing details such as profile ID, name, description, responsibilities, requirements, salary band, and more. If authentication fails, a 401 error is returned with a message indicating access denial.
Input Fields: Input Fields
Output Fields: Output Fields

Get Leave Hours Credit

ID: get_leave_hours_credit
Operation: read
Entities: user, pto policy, leave
Summary: The 'Get Leave Hours Credit' API endpoint allows users to retrieve the credit hours for a specific leave. It requires authentication through a user ID and API key provided in the headers. The request must include query parameters such as 'leaveDate', 'leaveId', 'leaveUserId', and 'ptoPolicyId'. The response will return a message indicating the success or failure of the request. Possible responses include a successful message, a bad request error, an unauthorized access error, or a conflict error.
Input Fields: Input Fields
Output Fields: Output Fields

Get Leave List

ID: get_leave_list
Operation: read
Entities: department, leave, user
Summary: The Get Leave List API retrieves a list of leave records for users within a specified date range. It requires a GET request to the endpoint https://acmecompany.bizmerlin.net/rm/api/leave/list. The request can include optional headers such as Authorization, userid, and x-api-key, and must include the startDate query parameter. The endDate query parameter is optional. The response includes detailed information about the leave records, including user details, leave type, and leave status. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Leave Process Details

ID: get_leave_process_details
Operation: read
Entities: user, process, leave
Summary: The Get Leave Process Details API allows users to retrieve details about a specific leave process by providing the leave ID and status as query parameters. The API requires authentication through the 'userid' and 'x-api-key' headers. The 'leaveId' parameter is an integer representing the leave's unique identifier, while the 'status' parameter is a string indicating the current status of the leave, with possible values including 'AP' (approved), 'WA' (waiting for approval), 'RJ' (rejected), 'PAP' (partially approved), and 'RCAL' (recalled). The API returns a JSON response with a message indicating the result of the request, which can be successful, a bad request, unauthorized access, or a conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Get Leave Requests

ID: get_leave_requests
Operation: read
Entities: department, leave request, user
Summary: The Get Leave Requests API retrieves leave requests for users. It requires authentication via headers 'userid' and 'x-api-key'. The query parameters include 'endDate' and 'startDate' which are mandatory, while 'leaveUserid' and 'status' are optional with defaults. The response includes detailed information about the leave requests, user details, and associated models. Possible response codes are 200 (OK), 400 (Bad Request), 401 (Unauthorized), and 409 (Conflict).
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve List of Activity Types

ID: get_list_of_activity_types
Operation: read
Entities: activity type, user, API key
Summary: This API endpoint retrieves a list of activity types based on the provided 'cid'. It requires authentication through headers, specifically 'x-api-key' and 'userid'. The response includes a list of activity types with details such as 'activityId', 'activityType', 'description', 'status', 'cid', and 'createts'. If the authentication fails, a 401 Unauthorized error is returned with a message indicating access denial. A 409 Conflict error may also be returned with a failure message.
Input Fields: Input Fields
Output Fields: Output Fields

Get List of Assigned Tests

ID: get_list_of_assigned_tests
Operation: read
Entities: assignment, user, dynamic form
Summary: The Get List of Assigned Tests API endpoint allows users to retrieve a list of tests assigned to them. It requires authentication through a user ID and an API key, both of which must be included in the request headers. The API responds with a detailed list of assigned tests, including information about the assignment, user details, and dynamic form models. The response includes a status code, data array with assignment details, and a message indicating success or failure. In case of authentication failure or other errors, appropriate error messages are returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get List of Positions

ID: get_list_of_positions
Operation: read
Entities: position, approval level, user group
Summary: The Get List of Positions API retrieves a list of positions from the BizMerlinHR system. It requires authentication using a user ID and an API key, both of which must be included in the request headers. The API supports optional query parameters such as 'search' for filtering positions, 'page' for pagination, and 'pageSize' to specify the number of positions per page. The response includes detailed information about each position, such as position ID, name, description, status, and more. Additionally, it provides a list of approval levels associated with the positions.
Input Fields: Input Fields
Output Fields: Output Fields

Get List of Projects

ID: get_list_of_projects
Operation: read
Entities: user, account, project
Summary: This API endpoint retrieves a list of projects from the BizMerlinHR application. It requires authentication using a user ID and an API key, both of which must be included in the request headers. The response includes detailed information about each project, such as project ID, name, description, start and end dates, contact person, account, status, creation timestamp, short code, probability, contact person name, status value, unique project identifier (puid), and billing type. The API returns a 200 status code with the project details on success, and appropriate error messages for 400, 401, and 409 status codes.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Objectives by User ID or Objective ID

ID: get_objectives_by_user_or_objective_id
Operation: read
Entities: objective, key result, user
Summary:
Input Fields: Input Fields
Output Fields: Output Fields

Get Organizational Units

ID: get_organizational_units
Operation: read
Entities: department, organization unit, user
Summary: The Get Organizational Units API retrieves a list of organizational units within the company. It requires authentication via a user ID and an API key, both of which must be included in the request headers. The response includes details about each department, such as department ID, name, description, department head, company ID, department code, department label, parent department ID and name, department head name, number of employees, and user model. If authentication fails, a 401 error is returned with a message indicating access denial.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve OrgRelations by User

ID: get_orgrelations_by_user
Operation: read
Entities: position, manager, org relation
Summary: This API endpoint retrieves all the organizational relations (OrgRelations) for a specified user, including active, archived, and future relations. The request requires authentication via headers 'x-api-key' and 'userid'. The 'email' query parameter is mandatory, while 'employeeUserId' and 'empId' are optional. The response includes detailed information about each OrgRelation, such as relation type, status, and associated user details. In case of unauthorized access, a 401 error is returned, and a 409 error indicates a conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Get Paystub Details

ID: get_paystub_details
Operation: read
Entities: employee, deduction, payroll
Summary: The Get Paystub Details API retrieves the paystub information for a user. It requires authentication through headers, specifically 'userid' and 'x-api-key'. The response includes detailed paystub data such as payStubId, payrollRunId, user details, payDate, totalGrossPay, taxes, deductions, netAmount, and more. A successful response returns a code of 1 and a message 'successful'.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Project Details by ID

ID: get_project_details_by_id
Operation: read
Entities: user, project
Summary: This API retrieves the details of a project by its ID. It requires the user to provide authentication details in the form of a user ID and an API key in the headers. The project ID must be specified in the path parameters. The response includes detailed information about the project such as project name, description, start and end dates, contact person, account, status, and other relevant details. In case of errors, appropriate error messages are returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get PTO Policies

ID: get_pto_policies
Operation: read
Entities: user, pto policy
Summary: The Get PTO Policies API retrieves a list of Paid Time Off (PTO) policies available in the system. It requires authentication via a user ID and an API key, both of which must be included in the request headers. The response includes detailed information about each PTO policy, such as policy ID, name, description, effective and expiration dates, accrual rates, and other relevant attributes. The response is returned in JSON format, with a 'data' array containing objects that represent individual PTO policies.
Input Fields: Input Fields
Output Fields: Output Fields

Get Report Content

ID: get_report_content
Operation: read
Entities: report, analytic, content
Summary: The Get Report Content API retrieves the content of a report based on the provided analyticId. It requires the analyticId as a query parameter. Optional headers include Authorization, userid, and x-api-key for authentication and identification purposes. The response returns a Python dictionary object if successful, or error messages for unauthorized, forbidden, or not found responses.
Input Fields: Input Fields
Output Fields: Output Fields

Get Report from BizMerlin API

ID: get_report_from_bizmerlin_api
Operation: read
Entities: report, analytic, authorization
Summary: The Get Report from BizMerlin API allows users to retrieve reports by providing an analytic ID as a query parameter. The API requires an 'analyticId' as a mandatory query parameter. Optional headers include 'Authorization', 'userid', and 'x-api-key'. The response includes a 200 status code with report data or an error message if an error occurs.
Input Fields: Input Fields
Output Fields: Output Fields

Get Resource Details

ID: get_resource_details
Operation: read
Entities: department, resource, user
Summary: The Get Resource Details API endpoint allows users to retrieve detailed information about resources from the BizMerlinHR application. The API requires authentication via a user ID and an API key, both of which must be included in the request headers. The endpoint supports several query parameters, including 'name', 'page', 'pageSize', 'sortBy', 'sortOrder', and 'status', which can be used individually or in combination to filter and sort the results. The response includes a code, a data array containing resource details such as resourceId, name, position, and other attributes, and a message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Custom Field by ID

ID: get_retrieve_custom_field_by_id
Operation: read
Entities: custom field group, custom field, user
Summary: The 'Retrieve Custom Field by ID' API endpoint allows users to retrieve details of a custom field by its ID. The request requires authentication through headers, including 'userid' and 'x-api-key'. The 'customFieldId' must be provided as a query parameter to specify which custom field to retrieve. The response includes detailed information about the custom field, such as its name, type, associated object type, and other metadata. The response also includes a message indicating the success or failure of the request.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Custom Fields

ID: get_retrieve_custom_fields
Operation: read
Entities: custom field, field group, field value
Summary: The Retrieve Custom Fields API allows clients to fetch custom fields from the BizMerlin platform. It requires the 'userid' and 'x-api-key' headers for authentication. An optional 'objectType' query parameter can be used to filter the results. The response includes a list of custom fields with detailed information such as customFieldId, customFieldName, customFieldType, and more. The API returns a 200 status code with the data on success, and appropriate error codes for unauthorized, forbidden, or not found responses.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Feedback

ID: get_retrieve_feedback
Operation: read
Entities: department, feedback, user
Summary: The Retrieve Feedback API allows users to fetch feedback data from the system. It requires authentication via 'userid' and 'x-api-key' headers. The 'type' query parameter specifies the feedback category to retrieve, with options 'all', 'my', or 'team'. The response includes a message and a list of feedback items, each containing detailed information about the feedback and the associated user.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve List of Active Allocations of User

ID: get_retrieve_list_of_active_allocations_of_user
Operation: read
Entities: user, allocation, project
Summary: This API endpoint retrieves a list of active allocations for a user. It requires the 'x-api-key' and 'userid' headers for authentication. The response includes a list of projects with details such as projectId, projectName, projectDesc, startDate, endDate, contactPerson, account, status, and other project-related information. If the authentication fails, a 401 Unauthorized error is returned with a message indicating the issue. A 409 Conflict error may also be returned with a failure message.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Test by Status

ID: get_retrieve_test_by_status
Operation: read
Entities: department, test, user
Summary: This API retrieves tests based on their status, which can be Active, Archived, or Draft. The request requires authentication headers including 'x-api-key' and 'userid'. The 'status' query parameter is mandatory and determines the type of tests to retrieve. The response includes detailed information about the test, including its dynamic form ID, name, description, and associated user and department models. The response also provides metadata about the test's sections, items, and other configurations.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Timecards

ID: get_retrieve_timecards
Operation: read
Entities: user, timecard, location
Summary: The Retrieve Timecards API allows users to fetch a list of timecards within a specified date range. The request requires the 'x-api-key' and 'userid' headers for authentication, and 'startDate' and 'endDate' as query parameters to define the timesheet period. The response includes details such as timesheet ID, clock-in status, and user information for each timecard. A successful response returns a message 'successful', while errors may return messages indicating unauthorized access or conflicts.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Timesheets

ID: get_retrieve_timesheets
Operation: read
Entities: department, timesheet, user
Summary: The Retrieve Timesheets API allows clients to fetch a list of timesheets for a specified user. The API requires authentication via headers 'x-api-key' and 'userid'. Optional query parameters include 'userID', 'startDate', and 'endDate' to filter the timesheets. The response includes detailed information about each timesheet, such as timesheet ID, user details, status, and time-related data. The API returns a successful message upon successful retrieval or an error message if authentication fails.
Input Fields: Input Fields
Output Fields: Output Fields

Save OrgRelation for User

ID: get_save_orgrelation_for_user
Operation: write
Entities: user, manager, org relation
Summary: This API endpoint saves the OrgRelation for a user. It requires authentication via an API key and user ID in the headers. The request must include several query parameters such as orgRelationId, userId, managerUserId, and managerEmail, among others. The response will indicate whether the operation was successful or if there was an error, such as unauthorized access or a conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Get Shift Details

ID: get_shift_details
Operation: read
Entities: shift, user, project
Summary: The Get Shift Details API allows users to retrieve shift information from the BizMerlinHR application. It requires authentication using a user ID and an API key, both of which must be included in the request headers. The API supports several optional query parameters, including projectId, userId, startDate, endDate, and status, which can be used individually or in combination to filter the results. The response includes detailed information about each shift, such as shift times, project details, user information, and more. The API returns a 200 status code with the shift data on success, a 401 status code if the user is unauthorized, and a 409 status code if there is a conflict or error.
Input Fields: Input Fields
Output Fields: Output Fields

Get Skills List

ID: get_skills_list
Operation: read
Entities: user, skill, api key
Summary: The Get Skills List API endpoint retrieves a list of skills from the BizMerlinHR application. It requires authentication using a user ID and an API key, both of which must be included in the request headers. The response includes an array of skill objects, each containing details such as sequence, createUserId, skillCode, description, createts, id, and status. A successful response returns a list of skills, while errors may occur if authentication fails or if there is an issue retrieving the skills.
Input Fields: Input Fields
Output Fields: Output Fields

Get Survey List

ID: get_survey_list
Operation: read
Entities: survey
Summary: The Get Survey List API endpoint retrieves a list of surveys from the BizMerlin platform. It is accessed via a GET request to the specified URL. The request can include optional headers such as 'Authorization' for bearer tokens, 'userid' as an integer, and 'x-api-key' for API key authentication. The response returns a JSON object with additional properties representing the survey data. Possible response codes include 200 for success, 401 for unauthorized access, 403 for forbidden access, and 404 if the resource is not found.
Input Fields: Input Fields
Output Fields: Output Fields

Sync Training Data with TalentLMS

ID: get_sync_training_data_with_talentlms
Operation: read
Entities: training, talentlms, user
Summary: This API endpoint synchronizes training data with TalentLMS. It requires the user to provide authentication details via headers, including 'x-api-key', 'redirectUrl', and 'userid'. The API returns a JSON response with details about the number of trainings created, existing trainings, user trainings, and updates. In case of errors, it returns appropriate error messages for unauthorized access or conflicts.
Input Fields: Input Fields
Output Fields: Output Fields

Get Task Details by Task ID

ID: get_task_details_by_task_id
Operation: read
Entities: task
Summary: This API endpoint retrieves the details of a specific task by its task ID. The request requires the task ID as a path parameter. Optional headers include 'Accept' to specify the response format, 'userid' for user authentication, and 'x-api-key' for API authentication. The response will contain the task details if the request is successful. Possible response codes include 200 (OK), 401 (Unauthorized), 403 (Forbidden), and 404 (Not Found).
Input Fields: Input Fields
Output Fields: Output Fields

Get Task List by User ID

ID: get_task_list_by_user_id
Operation: read
Entities: task, api key, user
Summary: This API endpoint retrieves a list of tasks associated with a specific user ID. It requires the 'userid' and 'x-api-key' headers for authentication. The 'Accept' header should be set to 'application/json'. The response will contain a JSON object with the task list if successful, or an error message if an error occurs. The API returns a 200 status code for a successful request, and may return 401 for unauthorized access, 403 for forbidden access, or 404 if the resource is not found.
Input Fields: Input Fields
Output Fields: Output Fields

Get Tasks by User Workflow ID

ID: get_tasks_by_user_workflow_id
Operation: read
Entities: task, authorization, user workflow
Summary: This API endpoint retrieves tasks associated with a specific user workflow ID. It requires the userworkflowid as a path parameter. Optional headers include Authorization, userid, and x-api-key for authentication and identification purposes. The Accept header must be set to application/json. The response will be a JSON object representing the tasks, or an error message if the request is unauthorized, forbidden, or the resource is not found.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Test Assignments by DynamicFormId

ID: get_test_assignments_by_dynamicformid
Operation: read
Entities: assignment, user, dynamic form
Summary: This API endpoint retrieves test assignments based on the provided dynamicFormId. It requires authentication through headers 'x-api-key' and 'userid', both of which are integers. The dynamicFormId is a query parameter that specifies the ID of the test to retrieve. The response includes detailed information about each assignment, such as assignmentId, status, and user models, among other properties. The response is structured as a JSON object with a 'data' array containing assignment details and a 'message' indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Get Test Details

ID: get_test_details
Operation: read
Entities: user, section, test
Summary: The Get Test Details API retrieves detailed information about a specific test identified by the dynamicFormId. It requires authentication through the userid and x-api-key headers. The API returns a comprehensive JSON response containing the test's metadata, sections, and items, along with user and group information. The response includes details such as the test's name, description, status, and associated user information. In case of authentication failure or other errors, appropriate error messages are returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Timecard Basic Details

ID: get_timecard_basic_details
Operation: read
Entities: user, timecard, project
Summary: This API endpoint retrieves basic details of timecards based on the User ID for users with the 'Add Time Cards For Other' permission. It requires authentication via an API key and user ID in the headers. The request can include query parameters such as userID (required), email, and guid. The response includes details like createUserID, startDateTime, cardId, description, and more. The API returns a 200 status code with the timecard details in JSON format if successful, or error codes like 400, 401, or 409 for various failure scenarios.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Timecard Details

ID: get_timecard_details
Operation: read
Entities: user, timecard, project
Summary: The Retrieve Timecard Details API allows users to fetch detailed information about a specific timecard using its ID. The API requires the 'Add Time Cards For Other' permission. The request must include the 'timecardId' as a path parameter, and optionally, the 'flatcustomfields' query parameter to determine if custom fields should be flattened. Authentication is required via 'x-api-key' and 'userid' headers. The response includes comprehensive details about the timecard, user, project, and other related entities. Possible response codes include 200 (OK), 403 (Forbidden), 404 (Not Found), and 409 (Conflict), each with a corresponding message.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Timesheet Approvals List

ID: get_timesheet_approvals_list
Operation: read
Entities: user, timesheet, approval
Summary: This API endpoint retrieves a list of timesheet approvals based on user permissions. It requires the 'x-api-key' and 'userid' headers for authentication, and 'startDate' and 'endDate' as query parameters to specify the timesheet period. The response includes detailed information about each timesheet approval, such as timesheet ID, user details, status, and time-related metrics. The API returns a successful message upon successful retrieval, or an error message if authentication fails or there is a conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Timesheet by ID

ID: get_timesheet_by_id
Operation: read
Entities: user, timesheet, approval flow
Summary: This API retrieves a timesheet by its ID. It requires the 'x-api-key' and 'userid' headers for authentication, and a 'timesheetId' query parameter to specify which timesheet to retrieve. The response includes detailed information about the timesheet, such as its start and end dates, status, total time, and associated user details. If authentication fails, a 401 Unauthorized error is returned. If there is a conflict in retrieving the timesheet, a 409 Conflict error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Timesheet Details by Timesheet ID

ID: get_timesheet_details_by_timesheet_id
Operation: read
Entities: user, timesheet, approval flow
Summary: This API endpoint retrieves the details of a timesheet by its ID. It requires the 'timeSheetId' as a path parameter, which is mandatory. The request must include headers 'x-api-key' and 'userid' for authentication. An optional query parameter 'flatcustomfields' can be provided to specify whether custom fields should be flattened. The response includes detailed information about the timesheet, such as its ID, start and end dates, user ID, status, comments, and audit logs. Possible error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 409 Conflict, each with a descriptive message.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Timesheet Preferences

ID: get_timesheet_preferences
Operation: read
Entities: user, authentication, timesheet preference
Summary: The Retrieve Timesheet Preferences API allows users to fetch a list of timesheet preferences based on the provided user credentials. The API requires two headers: 'x-api-key' for the API key and 'userid' for the user ID, both of which are mandatory for authentication. The API responds with a detailed list of timesheet preferences, including fields like 'timesheetStartDay', 'billablePrefValue', 'endDate', and more. If the authentication fails, a 401 Unauthorized error is returned with a message indicating the issue. In case of a conflict, a 409 error is returned with a failure message.
Input Fields: Input Fields
Output Fields: Output Fields

Get Training Content

ID: get_training_content
Operation: read
Entities: user, training, content
Summary: The Get Training Content API retrieves the content associated with a specific training session. It requires a 'trainingId' as a query parameter to specify which training content to retrieve. Additionally, the request must include 'userid' and 'x-api-key' in the headers for authentication purposes. The API responds with a 200 status code and an object containing the training content if successful. If the request is unauthorized, forbidden, or the content is not found, it returns 401, 403, or 404 status codes respectively.
Input Fields: Input Fields
Output Fields: Output Fields

Get Trainings Information

ID: get_trainings_information
Operation: read
Entities: training
Summary: The Get Trainings Information API endpoint allows users to retrieve information about trainings from the BizMerlin platform. This API requires two headers: 'userid', which is an integer representing the user's ID, and 'x-api-key', which is a string representing the API key for authentication. The API responds with a 200 status code and an object containing the training information if the request is successful. If the request is unauthorized, forbidden, or the resource is not found, it returns 401, 403, or 404 status codes respectively. The response body for a successful request is an iterable object, while errors are returned with a detailed message.
Input Fields: Input Fields
Output Fields: Output Fields

Update User Status

ID: get_update_user_status
Operation: read
Entities: user, api key
Summary: The 'Update User Status' API endpoint allows you to update the status of a user in the BizMerlinHR system. This API requires the 'userid' and 'x-api-key' to be provided in the headers for authentication. The 'userid' is an integer representing the user's ID, and the 'x-api-key' is a string representing the user's API key. The API returns a JSON response with a 'code' and 'message' indicating the result of the operation. A successful operation will return a code of 200 and a message indicating success. If authentication fails, a 401 Unauthorized error will be returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Allocations for Project

ID: get_user_allocations_for_project
Operation: read
Entities: user, allocation, project
Summary: This API endpoint retrieves all user allocations for a specified project. It requires authentication using a user ID and an API key, both of which must be included in the request headers. The project ID must be specified in the path parameters. The response includes detailed information about each user's allocation to the project, including user details, project details, and allocation specifics.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Appraisal Details

ID: get_user_appraisal_details
Operation: read
Entities: department, appraisal, user
Summary: The Get User Appraisal Details API retrieves detailed information about a user's appraisal. It requires authentication via headers, including 'userid' and 'x-api-key'. The response includes a comprehensive set of data about the appraisal, such as appraisal ID, name, description, user details, department information, and more. The response is structured with a 'code' indicating success, a 'data' array containing appraisal details, and a 'message' indicating the result of the request.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Compensation Details

ID: get_user_compensation_details
Operation: read
Entities: user, compensation, location
Summary: The Get User Compensation Details API retrieves detailed compensation information for a specified user. The API requires authentication using a user ID and an API key, both of which must be included in the request headers. Additionally, the user ID must be specified as a query parameter, and an optional email parameter can be included. The response includes comprehensive details about the user's compensation, including financial information, user profile, and location details. The API returns a JSON array of compensation records, each containing fields such as compensation ID, user ID, financial ID, value, period, and detailed user model information. The user model includes personal details, employment information, and location data. The API also handles unauthorized access with a 401 response.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Details

ID: get_user_details
Operation: read
Entities: employment model, address model, user
Summary: The Get User Details API retrieves detailed information about a user from the BizMerlinHR application. It requires authentication using a user ID and an API key, both of which must be included in the request headers. Additionally, the user ID must be specified as a query parameter. The API returns a comprehensive JSON object containing various details about the user, including personal information, employment history, education, addresses, and custom fields. The response includes fields such as 'firstName', 'lastName', 'email', 'employmentModelList', 'educationModelList', and more, providing a complete profile of the user.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Goal List

ID: get_user_goal_list
Operation: read
Entities: user, goal
Summary: The Get User Goal List API retrieves the list of goals for a specified user. It requires the user ID to be provided as a query parameter and authentication details in the headers. The API returns a message indicating the success of the operation. If the request is successful, a message 'Successfully retrieved the goal list.' is returned in the response body. The API requires the 'userid' and 'x-api-key' headers for authentication and the 'userId' query parameter to specify the user whose goals are to be retrieved.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Information from BizMerlinHR

ID: get_user_information_from_bizmerlinhr
Operation: read
Entities: assignment, user, dynamic form
Summary: This API endpoint retrieves user information from the BizMerlinHR application. It requires authentication using a user ID and an API key, both of which must be included in the request headers. The response includes detailed information about the user's assignments, dynamic forms, and other related data. The response is structured in a complex JSON format with nested objects and arrays, providing comprehensive details about the user's profile, assignments, and associated models.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Leave Details

ID: get_user_leave_details
Operation: read
Entities: department, leave, user
Summary: The Get User Leave Details API allows clients to retrieve detailed information about user leaves from the BizMerlinHR system. The API requires authentication via headers, specifically a 'userid' and 'x-api-key'. The response includes comprehensive data about the user's leave details, including user profile, department, and leave policy information. The API returns a 200 status code with detailed leave data on success, and appropriate error messages for bad requests, unauthorized access, or conflicts.
Input Fields: Input Fields
Output Fields: Output Fields

Get User List

ID: get_user_list
Operation: read
Entities: department, profile, user
Summary: The Get User List API endpoint retrieves a list of users from the system. It requires authentication via a user ID and API key provided in the headers. The API supports an optional query parameter 'name' to filter users by name. The response includes detailed information about each user, such as user ID, name, contact details, job title, department, and more. The API returns a 200 status code with user details on success, and a 401 status code if unauthorized.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Permissions

ID: get_user_permissions
Operation: read
Entities: user, permission, app menu model
Summary: The Get User Permissions API allows you to retrieve the permissions associated with a user in the BizMerlinHR application. This API requires authentication using a user ID and an API key, both of which must be included in the request headers. The response includes a list of user group functions and a detailed app menu model that outlines various permissions and menu options available to the user. The response is structured in a JSON format, providing a comprehensive view of the user's access rights within the application.
Input Fields: Input Fields
Output Fields: Output Fields

Get User PTO Details

ID: get_user_pto_details
Operation: read
Entities: user, pto policy, leave
Summary: The Get User PTO Details API retrieves the Paid Time Off (PTO) details for a specific user. It requires authentication through the 'userid' and 'x-api-key' headers. The response includes detailed information about the user's PTO policies, balance, and usage. The API returns a JSON object containing a 'code', 'data', and 'message'. The 'data' field is an array of objects, each representing a PTO record with fields such as 'userPtoId', 'userId', 'ptoPolicyModel', 'balance', 'status', and more. The 'ptoPolicyModel' provides comprehensive details about the PTO policy, including policy name, description, accrual rates, and conditions.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve User Skills

ID: get_user_skills
Operation: read
Entities: assessment, skill, user
Summary: The Retrieve User Skills API allows you to fetch the skills associated with a specific user. To use this API, you need to provide the 'assignedUserID' as a query parameter, which is the ID of the user whose skills you want to retrieve. Additionally, you must include 'userid' and 'x-api-key' in the headers for authentication purposes. The API returns a list of skills with detailed information such as skill ID, user ID, level, description, and more. The response also includes a message indicating the success of the operation. If authentication fails, a 401 error is returned with a message indicating access denial. If there is an error in retrieving the skills, a 409 error is returned with an appropriate message.
Input Fields: Input Fields
Output Fields: Output Fields

Fetch User Specific Attachments

ID: get_user_specific_attachments
Operation: read
Entities: user, attachment
Summary: This API endpoint allows you to fetch attachments specific to a user identified by the 'targetUserId'. The request requires authentication through the 'requesterUserId' and 'x-api-key' headers. The response includes an array of attachment objects, each containing details such as 'fileName', 'extension', 'comments', 'size', 'createUserId', and 'createts'. The API returns various status codes including 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 for not found, and 409 for conflict errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve User Timecard Details

ID: get_user_timecard_details
Operation: read
Entities: user, timecard, project
Summary: The Retrieve User Timecard Details API allows users to fetch detailed timecard information for a specific user. This API requires authentication via an API key and user ID provided in the headers. The user ID for which the timecard details are to be retrieved must be specified as a query parameter. Optional query parameters include the user's email and graphical user ID (GUID). The response includes comprehensive details about the timecard, such as user information, project details, timecard status, and more. The API returns a detailed JSON object with fields like cardId, userModel, projectModel, and various timestamps and status indicators.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Workflows

ID: get_user_workflows
Operation: read
Entities: user, workflow
Summary: The Get User Workflows API retrieves workflows associated with a specific user ID. It requires headers such as 'Authorization', 'userid', and 'x-api-key', although they are not mandatory. The 'Accept' header is required and should be set to 'application/json'. The API returns a JSON object containing the workflows. If the request is unauthorized, forbidden, or not found, it will return the respective HTTP status codes 401, 403, or 404.
Input Fields: Input Fields
Output Fields: Output Fields

Verify TVC

ID: get_verify_tvc
Operation: read
Entities:
Summary: The Verify TVC API endpoint is used to verify TVC details. It requires a query parameter 'cid' which is an integer and is mandatory. The API uses the GET method and accepts headers with the 'accept' field to specify acceptable media types for the response. The response can be a 200 OK with an empty object, or it can return error codes such as 401 Unauthorized, 403 Forbidden, or 404 Not Found. The response example also includes an error message for a stale element reference exception.
Input Fields: Input Fields
Output Fields: Output Fields

View Position Details

ID: get_view_position_details
Operation: read
Entities: department, recruiter, position
Summary: The View Position Details API allows users to retrieve detailed information about a specific position within the BizMerlinHR system. The API requires authentication via a user ID and an API key, both of which must be included in the request headers. Additionally, the position ID must be specified as a query parameter. Upon successful request, the API returns a comprehensive JSON object containing various details about the position, such as its name, status, description, associated project, and more. The response also includes information about the recruiter, department, location, and other related entities. In case of errors, appropriate error messages are returned.
Input Fields: Input Fields
Output Fields: Output Fields

View Survey Details

ID: get_view_survey_details
Operation: read
Entities: survey
Summary: The View Survey Details API allows users to retrieve details of a survey by making a GET request to the specified endpoint. The request can include optional headers such as 'Authorization', 'userid', and 'x-api-key', as well as an optional query parameter 'dynamicFormId' to specify the ID of the dynamic form. The response will return a JSON object with survey details if successful, or an error message if there is an issue such as unauthorized access or a missing element.
Input Fields: Input Fields
Output Fields: Output Fields

Get Workflows with Status

ID: get_workflows_with_status
Operation: read
Entities: user, status, workflow
Summary: This API endpoint retrieves workflows with a specified status from the BizMerlinHR application. The request requires a 'userid' header and optionally accepts an 'x-api-key' header for authentication. The 'status' query parameter can be used to filter workflows by their status, with a default value of 'A'. The response returns an iterable object containing the workflows if successful, or an error message if not.
Input Fields: Input Fields
Output Fields: Output Fields

Add Organizational Unit

ID: post_add_organizational_unit
Operation: write
Entities: department, employee, org unit
Summary: The Add Organizational Unit API allows users to add a new organizational unit to the system. It requires authentication via user ID and API key in the headers. The API accepts several query parameters including the name and description of the org unit, department head details, department code, ID, label, number of employees, and parent department details. On successful addition, it returns a message indicating success.
Input Fields: Input Fields
Output Fields: Output Fields

Add Performance Appraisal

ID: post_add_performance_appraisal
Operation: write
Entities: user, appraisal, performance review
Summary: The Add Performance Appraisal API allows users to create a new performance review for a specified user. The API requires authentication via headers 'userid' and 'x-api-key'. It accepts query parameters such as 'userId', 'templateId', 'StartDate', 'EndDate', and 'AppraisalType'. The 'userId' and 'templateId' are mandatory, while 'StartDate', 'EndDate', and 'AppraisalType' are optional with 'AppraisalType' defaulting to 'Annual'. Upon successful creation, it returns a 201 response with 'appraisalId' and a success message. Errors may result in 400 or 409 responses with appropriate messages.
Input Fields: Input Fields
Output Fields: Output Fields

Add Skill to BizMerlinHR

ID: post_add_skill_to_bizmerlinhr
Operation: write
Entities: assessment model, skill, skill type model
Summary: This API endpoint allows users to add a new skill to the BizMerlinHR system. The request requires authentication headers including 'userid' and 'x-api-key'. The request body must include a description and skill code for the skill being added. Additional optional parameters include assessment and skill type models, which provide detailed information about the skill's assessment criteria and type. The response will confirm the creation of the skill with a status message and details of the created skill, including its ID and associated models. Possible response codes include 201 for success, 401 for unauthorized access, and 409 for conflict errors.
Input Fields: Input Fields
Output Fields: Output Fields

Add Task

ID: post_add_task
Operation: write
Entities: task, user, project
Summary: The Add Task API allows users to create a new task in the system. It requires authentication via headers 'x-api-key' and 'userid'. The request body must include 'title' and 'assignedUserId' as required fields, with optional fields 'description' and 'dueDate'. Upon successful creation, it returns a message and a detailed TaskModel object containing information about the created task. Possible error responses include 400 for data format issues, 401 for authentication failures, and 409 for task creation errors.
Input Fields: Input Fields
Output Fields: Output Fields

Add User Compensation

ID: post_add_user_compensation
Operation: write
Entities: user, status, compensation
Summary: The Add User Compensation API allows you to add a compensation entry for a user in the BizMerlinHR system. It requires authentication via a user ID and API key in the headers. The API accepts several query parameters including 'value' for the compensation amount, 'compensationType' to specify the type of compensation, 'userId' for the user receiving the compensation, 'currencyCode' for the currency, 'period' for the time period of the compensation, 'effectivedate' and 'enddate' for the duration, 'status' to indicate the status of the compensation, and optional 'notes'. The response includes a GUID for the compensation entry and a message indicating the success or failure of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Add User Organization Relation

ID: post_add_user_organization_relation
Operation: write
Entities: user, employee, manager
Summary: This API endpoint is used to add a user organization relation in the BizMerlinHR system. It requires authentication via a user ID and API key in the headers. The request must include the user ID as a query parameter, and optionally the employee ID and email. The request body should contain an array of objects specifying the relation details, including the associate OID, manager ID, relation type, start date, and end date. A successful response returns a message indicating the relation was added successfully.
Input Fields: Input Fields
Output Fields: Output Fields

Add User PTO Balance

ID: post_add_user_pto_balance
Operation: write
Entities: pto balance, api key, user
Summary: The Add User PTO Balance API allows clients to add PTO (Paid Time Off) balance for a user. The API requires authentication via headers, including 'userid' and 'x-api-key'. The request body must include 'ptobalances', which specifies the PTO balance to be added. On success, the API returns a message indicating the PTO balance was added successfully. Possible responses include 201 (Created), 400 (Bad Request), 401 (Unauthorized), and 409 (Conflict), each with a corresponding message.
Input Fields: Input Fields
Output Fields: Output Fields

Add User to BizMerlinHR

ID: post_add_user_to_bizmerlinhr
Operation: write
Entities: user, message, api key
Summary: This API endpoint allows you to add a new user to the BizMerlinHR system. To authenticate, you must provide the 'userid' and 'x-api-key' in the headers. The 'firstName' and 'email' of the user must be provided as query parameters. Upon successful addition, the API returns a message and the userID of the newly added user. If authentication fails, it returns an 'Unauthorized' message.
Input Fields: Input Fields
Output Fields: Output Fields

Assign Project to User

ID: post_assign_project_to_user
Operation: write
Entities: assignment, user, project
Summary: This API assigns a project to a user based on the provided project ID and user ID. It requires authentication using a user ID and an API key, both of which should be included in the request headers. The request body must contain the projectId and userId. Upon successful assignment, the API returns a userProjectId, which is the ID of the assignment. Possible response codes include 201 for success, 400 for bad request, 401 for unauthorized access, and 409 for conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Assign Workflow to User

ID: post_assign_workflow_to_user
Operation: write
Entities: user, workflow, api key
Summary: This API endpoint allows you to assign a workflow to a user. It requires the workflow ID as a path parameter, and the API key and user ID as headers for authentication. Additionally, it requires the assignee user ID and coordinator user ID as query parameters. An optional comment can also be provided. The API returns a message indicating the success or failure of the operation, with possible responses including success, incorrect details, permission issues, not found, or an error during assignment.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Launch Appraisals

ID: post_bulk_launch_appraisals
Operation: write
Entities: user, template, appraisal
Summary: The Bulk Launch Appraisals API allows users to initiate multiple appraisals at once using a specified template and review type. The API requires authentication via a user ID and API key in the headers. Optional query parameters include templateId, reviewType, startDate, endDate, importGoals, importJobProfileSkills, importSkills, and userIdList. The response is a JSON object, with a 200 status code indicating success and a 400 status code indicating a format error in the data parameters.
Input Fields: Input Fields
Output Fields: Output Fields

Clock In Timesheet

ID: post_clock_in_timesheet
Operation: write
Entities: timecard, timesheet, project
Summary: This API allows users to clock in by sending a POST request to the specified endpoint. The request requires authentication via headers 'x-api-key' and 'userid'. Optional query parameters include 'proceedOutsideGeoFence', 'description', 'projectId', 'projectManager', 'categoryCode', 'notes', 'billable', 'activity', 'approvalRejectionReason', 'clockInLongitude', 'clockInLatitude', 'clockOutLongitude', 'clockOutLatitude', and 'projectAreaId'. The response returns a JSON object containing 'timesheetId', 'timecardId', 'startTime', and a 'message' indicating the result of the clock-in operation. Possible response codes include 201 (Created), 401 (Unauthorized), 403 (Forbidden), and 409 (Conflict).
Input Fields: Input Fields
Output Fields: Output Fields

Clock Out Timesheet

ID: post_clock_out_timesheet
Operation: write
Entities: user, timecard, project
Summary: This API allows a user to clock out from their timesheet. It requires authentication through headers 'x-api-key' and 'userid'. The API supports various optional query parameters such as 'proceedOutsideGeoFence', 'description', 'projectId', 'projectManager', 'categoryCode', 'notes', 'billable', 'activity', 'approvalRejectionReason', 'clockInLongitude', 'clockInLatitude', 'clockOutLongitude', 'clockOutLatitude', and 'projectAreaId'. The response includes the start time, end time, a message, and the elapsed time. Possible error responses include 401 Unauthorized and 409 Conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Complete User Details

ID: post_complete_user_details
Operation: write
Entities: user, authentication, api key
Summary: The Complete User Details API allows clients to authenticate and retrieve complete details of a user. It requires two headers: 'userid', which is the ID of the user to authenticate, and 'x-api-key', which is the API key for authentication. The API responds with a message indicating the result of the operation. A successful response will include a message such as 'User created successfully.' If authentication fails, a 401 Unauthorized error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Project

ID: post_create_a_new_project
Operation: write
Entities: user, api key, project
Summary: This API endpoint allows users to create a new project in the BizMerlinHR system. The request requires authentication through the 'userid' and 'x-api-key' headers. The request body must include 'projectName', 'projectDesc', 'shortCode', and 'startDate'. Upon successful creation, the API returns the 'projectId' of the new project. Possible error responses include 400 for bad requests, 401 for unauthorized access, and 409 for conflicts or other errors.
Input Fields: Input Fields
Output Fields: Output Fields

Create Announcement

ID: post_create_announcement
Operation: write
Entities: user, announcement, notification
Summary: The Create Announcement API allows users to create a new announcement in the system. It requires authentication using a user ID and an API key, both of which must be included in the request headers. The API accepts query parameters such as 'title', 'description', 'url', and 'status' to define the details of the announcement. The 'title' and 'description' are mandatory fields, while 'url' and 'status' are optional. The 'status' parameter can be set to 'A' for Active, 'D' for Draft, or 'I' for Archive, with 'A' being the default. Upon successful creation, the API returns the announcement ID and a success message. If authentication fails, a 401 error with an appropriate message is returned. In case of any other failure, a 409 error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Create Candidate

ID: post_create_candidate
Operation: write
Entities: candidate
Summary: The Create Candidate API allows users to create a new candidate in the system. It requires authentication via a user ID and API key in the headers. The API accepts several optional query parameters including the candidate's name, email, phone number, and a flag indicating if the candidate is new. The source parameter defaults to 'API'. On success, it returns a 201 status with a message indicating success. If unauthorized, it returns a 401 status with an 'unauthorized' message. If a candidate with the same email already exists, it returns a 409 status with an appropriate message.
Input Fields: Input Fields
Output Fields: Output Fields

Create Expense Item

ID: post_create_expense_item
Operation: write
Entities: user, project, expense item
Summary: The Create Expense Item API allows users to create a new expense item in the BizMerlinHR system. The API requires authentication through the 'userid' and 'x-api-key' headers. The request must include query parameters such as 'amount', 'currencyCode', 'date', 'remarks', 'userId', 'expenseItemId', and 'expenseTypeId'. Optional parameters include 'billable', 'cid', 'expenseType', 'projectId', and 'reimbursible'. Upon successful creation, the API returns the 'expenseItemId' and a success message.
Input Fields: Input Fields
Output Fields: Output Fields

Create Expense Report

ID: post_create_expense_report
Operation: write
Entities: user, api key, expense report
Summary: This API endpoint allows users to create an expense report in the BizMerlinHR system. The request requires authentication via 'userid' and 'x-api-key' headers. The 'name' query parameter is mandatory and specifies the name of the expense report. Optional query parameters include 'amount', which is the amount to be added to the expense report, and 'description', which provides additional details about the expense report. Upon successful creation, the API returns a message and an 'expenseReportId'. If the user lacks permission, a 401 error is returned, and a 409 error is returned for other issues.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Leave Request

ID: post_create_new_leave_request
Operation: write
Entities: time off, leave, leave request
Summary: This API endpoint allows the creation of a new leave request for a user. It requires authentication via headers 'userid' and 'x-api-key'. The request body must include the date of the leave, a description, the number of days requested, total leave days, total leave hours, and user and policy details. Upon successful creation, it returns a message indicating the leave request was created successfully. Possible error responses include unauthorized access, bad request, or conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update Custom Field Values

ID: post_create_or_update_custom_field_values
Operation: write
Entities: custom field, authentication, user
Summary: This API endpoint allows you to create or update custom field values for a user in the BizMerlin system. It requires authentication via a user ID and API key in the headers. The query parameters include 'customFieldId', 'customFieldCode', 'userId', 'userEmail', 'empId', and 'value', where 'customFieldId', 'userId', and 'value' are required. The response will include a message indicating the success or failure of the operation. Possible response codes include 200 for success, 401 for authentication failure, and 409 for a conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update Goal

ID: post_create_or_update_goal
Operation: write
Entities: user, goal, project
Summary: This API endpoint is used to create or update a goal in the system. It requires authentication via headers 'userid' and 'x-api-key'. The API accepts various optional query parameters such as 'additive', 'begindate', 'cid', 'commentCrediteatets', 'commentDescription', 'companyGoal', 'completionRatio', 'createUserId', 'createts.date', 'createts.day', 'createts.hours', 'createts.minutes', 'createts.month', 'createts.nanos', 'createts.seconds', 'createts.time', 'createts.timezoneOffset', 'createts.year', 'crediteatets', 'currentValue', 'description', 'disposition', 'elapsedTimeRatio', 'goalId', 'goalValue', 'goalWeightage', 'hasGoalApprovalPermission', 'id', 'initialvalue', 'isForward', 'lastUpdateUserId', 'objectiveId', 'parentGoalId', 'progressRatio', 'projectid', 'reviewUserId', 'state', 'status', 'summary', 'targetDate', 'typecode', 'uname', 'units', 'visibleToDirectReports'. The response can be a 200 OK with an iterable object, 201 Created, 401 Unauthorized, 403 Forbidden, or 404 Not Found.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update Timesheet

ID: post_create_or_update_timesheet
Operation: write
Entities: timecard, timesheet, project
Summary: This API endpoint allows users to create a new timesheet or update an existing timesheet. It requires authentication through the 'x-api-key' and 'userid' headers. The request must include query parameters such as 'date', 'projectId', and 'elapsedTime'. Optional parameters include 'cardId', 'description', 'clockedOutsideGeofence', 'projectManager', 'categoryCode', 'notes', 'billable', 'activity', 'approvalRejectionReason', 'clockInLongitude', 'clockInLatitude', 'clockOutLongitude', 'clockOutLatitude', and 'projectAreaId'. The response will return a 'timesheetId', 'timecardId', and a 'message' indicating success or failure. Possible error responses include 401 Unauthorized, 403 Forbidden, and 409 Conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Expense Item

ID: post_delete_expense_item
Operation: write
Entities: user, API key, expense item
Summary: The Delete Expense Item API allows users to delete an expense item by providing the expense item ID as a query parameter. The request requires authentication through the 'userid' and 'x-api-key' headers. A successful request returns a message indicating success. If the authentication fails, a 401 Unauthorized error is returned with a message indicating access denial. If the specified expense item is not found, a 404 error is returned with a message indicating the item was not found. In case of a conflict, a 409 error is returned with a failure message.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Expense Report

ID: post_delete_expense_report
Operation: write
Entities: user, api key, expense report
Summary: The Delete Expense Report API allows users to delete an expense report by providing the expenseReportId as a query parameter. The request requires authentication through the userid and x-api-key headers. Upon successful deletion, the API returns a message indicating success. If an error occurs, an error message is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Timesheet by Timesheet ID

ID: post_delete_timesheet_by_timesheet_id
Operation: write
Entities: user, timesheet, api key
Summary: This API deletes a timesheet by its Timesheet ID. It requires authentication through headers 'x-api-key' and 'userid'. The 'timesheetId' must be provided as a query parameter. On successful deletion, it returns a message 'successful'. If authentication fails, it returns a message indicating access denial. In case of a conflict, it returns a message 'failure.'.
Input Fields: Input Fields
Output Fields: Output Fields

Delete User Address

ID: post_delete_user_address
Operation: write
Entities: user, address
Summary: The Delete User Address API allows authenticated users to delete a specific address associated with a user account. The API requires the 'userid' and 'x-api-key' to be provided in the headers for authentication. Additionally, the 'addressId' must be specified as a query parameter to identify the address to be deleted. Upon successful deletion, a message confirming the deletion is returned. If the authentication details are incorrect, a 401 error message is returned. If the address or user details are not found, a 404 error message is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Delete User Contact

ID: post_delete_user_contact
Operation: write
Entities: user, dependent, contact
Summary: The Delete User Contact API allows authenticated users to delete a contact by providing the contact ID. The request requires the 'userid' and 'x-api-key' headers for authentication, and the 'contactId' query parameter to specify which contact to delete. Upon successful deletion, the API returns a message indicating success. If the contact is not found, a message indicating the contact was not found is returned. In case of a conflict, a failure message is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Delete User Education

ID: post_delete_user_education
Operation: write
Entities: user, education, message
Summary: The Delete User Education API allows you to delete a specific education record for a user in the BizMerlinHR system. To use this API, you must provide the user's ID and API key in the headers for authentication. Additionally, you need to specify the education ID in the query parameters to identify which education record to delete. The API responds with a message indicating the result of the operation. Possible responses include a success message, unauthorized access, user address not found, or a failure message.
Input Fields: Input Fields
Output Fields: Output Fields

Delete User Employment

ID: post_delete_user_employment
Operation: write
Entities: user, api key, employment
Summary: The Delete User Employment API allows the deletion of a user's employment record in the BizMerlinHR system. It requires the 'empid' as a query parameter to specify the employee's unique identity. The request must include 'userid' and 'x-api-key' in the headers for authentication. A successful request returns a 201 status with a message indicating successful deletion. If the details are incorrect, a 401 status is returned with an appropriate message. If the employment details are not found, a 404 status is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Edit Expense Item

ID: post_edit_expense_item
Operation: write
Entities: user, expense type, expense item
Summary: The Edit Expense Item API allows users to edit an existing expense item in the system. It requires authentication through the 'userid' and 'x-api-key' headers. The API accepts several query parameters including 'amount', 'currencyCode', 'date', 'remarks', 'userId', 'expenseItemId', 'billable', 'cid', 'expenseType', 'expenseTypeId', 'projectId', and 'reimbursible'. The response will include a message indicating the success or failure of the operation. Possible responses include a success message, an unauthorized error if authentication fails, a not found error if the expense item does not exist, and a conflict error for other failures.
Input Fields: Input Fields
Output Fields: Output Fields

Save Address Details

ID: post_save_address_details
Operation: write
Entities: user, employee, address
Summary: The Save Address Details API allows users to save address information for a specific user. It requires authentication via headers 'userid' and 'x-api-key'. The API accepts query parameters 'userID', 'empId', and 'email' to identify the user and employee. The request body must include address details such as 'addressLine1', 'addressLine2', 'addressType', 'zipCode', 'city', 'countryId', and 'state'. Upon successful execution, the API returns a message indicating that the address details were saved successfully.
Input Fields: Input Fields
Output Fields: Output Fields

Save Custom Field Values

ID: post_save_custom_field_values
Operation: write
Entities: user, custom field, employee
Summary: The 'Save Custom Field Values' API allows users to save custom field values for a user in the BizMerlinHR system. The API requires authentication through a user ID and an API key, both of which must be included in the request headers. Optional query parameters include 'userID', 'empId', and 'email'. The API responds with a success message if the custom field values are saved successfully, or an error message if there is an issue.
Input Fields: Input Fields
Output Fields: Output Fields

Save Education Details

ID: post_save_education_details
Operation: write
Entities: course, employee, education
Summary: The Save Education Details API allows users to save education details for a specific user. It requires authentication via 'userid' and 'x-api-key' headers. The API accepts query parameters such as 'userID', 'empId', and 'email'. The request body should contain an array of education details including course name, degree, institution, GPA, state, city, country ID, start date, and end date. On successful execution, it returns a message indicating that the education details were saved successfully.
Input Fields: Input Fields
Output Fields: Output Fields

Save Employment Details

ID: post_save_employment_details
Operation: write
Entities: department, employment, user
Summary: The Save Employment Details API allows users to save employment details for a specific user. It requires authentication using a user ID and an API key provided in the headers. The API accepts query parameters such as userID, empId, and email, and a request body containing employment details like employer name, position, department, state, start and end dates, city, and country ID. Upon successful execution, it returns a message indicating that the employment details were saved successfully.
Input Fields: Input Fields
Output Fields: Output Fields

Save Form Response

ID: post_save_form_response
Operation: write
Entities: assignment, form, user
Summary: The Save Form Response API allows users to save a form response by providing the necessary authentication details and assignment ID. The API requires the 'userid' and 'x-api-key' in the headers for authentication, and the 'assignmentId' as a query parameter. Upon successful execution, it returns a response code and message indicating success. If authentication fails, it returns an error message indicating access denial.
Input Fields: Input Fields
Output Fields: Output Fields

Save Item Response

ID: post_save_item_response
Operation: write
Entities: assignment, item, response
Summary: The Save Item Response API allows users to save a response value for a specific form item. It requires the user to provide authentication details via headers, including 'userid' and 'x-api-key'. The query parameters 'assignmentId', 'itemId', and 'responseValue' are mandatory to specify the assignment, item, and response value respectively. Upon successful execution, the API returns a success message with a code. If authentication fails, it returns an unauthorized access message.
Input Fields: Input Fields
Output Fields: Output Fields

Save Position in BizMerlinHR

ID: post_save_position
Operation: write
Entities: position, funnel, approval flow
Summary: The Save Position API allows users to create or update a position in the BizMerlinHR system. It requires authentication via 'userid' and 'x-api-key' headers. The API accepts various query parameters such as 'name', 'description', 'count', 'status', 'accessLevel', 'requirements', 'responsibilities', 'dateOpen', 'dateClose', 'positionUID', 'projectid', 'funnelId', 'approvalFlowId', 'locationid', 'departmentId', 'profileid', and 'recruiterId'. The response returns a message indicating whether the operation was successful or not.
Input Fields: Input Fields
Output Fields: Output Fields

Save Shift Details

ID: post_save_shift_details
Operation: write
Entities: shift, user, project
Summary: The Save Shift Details API allows users to save shift information for a specific user project. It requires authentication via an API key and user ID, both of which must be included in the request headers. The request body must contain the shift date, start time, end time, user project ID, and status. The API returns a 200 status code upon successful execution, with an empty JSON object in the response body. In case of errors, an error message is returned detailing the issue.
Input Fields: Input Fields
Output Fields: Output Fields

Save Survey

ID: post_save_survey
Operation: write
Entities: assignment, user, survey
Summary: The Save Survey API endpoint allows users to save survey data. It requires a POST request to the specified URL with optional headers for Authorization, userid, and x-api-key. The assignmentId is a required query parameter. The API returns a JSON object in the response body. Possible response codes include 200 (OK), 201 (Created), 401 (Unauthorized), 403 (Forbidden), and 404 (Not Found).
Input Fields: Input Fields
Output Fields: Output Fields

Save Survey Item

ID: post_save_survey_item
Operation: write
Entities: item, response, survey
Summary: The Save Survey Item API allows users to save a survey item by providing the necessary query parameters such as assignmentId, itemId, and responseValue. The API accepts optional headers for Authorization, userid, and x-api-key. Upon successful execution, it returns a response indicating the status of the operation. The possible responses include 200 OK, 201 Created, 401 Unauthorized, 403 Forbidden, and 404 Not Found. The response body is expected to be an object, but no specific example is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Submit Expense Report

ID: post_submit_expense_report
Operation: write
Entities: user, api key, expense report
Summary: The Submit Expense Report API allows users to submit an expense report by providing the expenseReportId in the path parameters. The request requires authentication through the userid and x-api-key headers. The status of the expense report is specified as a query parameter, defaulting to 'SUB'. Upon successful submission, the API returns a confirmation message and the ID of the submitted expense report.
Input Fields: Input Fields
Output Fields: Output Fields

Update Task Status

ID: post_update_task_status
Operation: write
Entities: task, status, user
Summary: The Update Task Status API allows users to update the status of a task in the system. It is a POST request to the endpoint https://acmecompany.bizmerlin.net/rm/api/v3/task/update/status. The API accepts various optional query parameters such as appraisalId, assignedUserId, ci, cid, createUserId, createts, description, dueDate, lastEdit, launchts (with subfields like date, day, hours, etc.), phasename, projectId, recruitId, statusCode, systemTask, taskId, taskUID, title, transitionName, and type. It also accepts optional headers for Authorization and x-api-key. The response can return different status codes like 200 (OK), 201 (Created), 401 (Unauthorized), 403 (Forbidden), and 404 (Not Found). The response body is expected to be a Python object representation.
Input Fields: Input Fields
Output Fields: Output Fields

Update Timesheet Status

ID: post_update_timesheet_status
Operation: write
Entities: timesheet, timesheet status, API key
Summary: The Update Timesheet Status API allows users to update the status of a timesheet by providing the Timesheet ID and the desired status. The API requires authentication through an API key and user ID, both of which must be included in the request headers. The status of the timesheet can be set to one of several predefined values, such as 'PD' for Pending Approval or 'AP' for Fully Approved. Optional comments can also be included in the request. The API returns a success message upon successful update, or an error message if authentication fails or if there is a conflict.
Input Fields: Input Fields
Output Fields: Output Fields

Update User Compensation

ID: post_update_user_compensation
Operation: write
Entities: user, status, compensation
Summary: The Update User Compensation API allows updating the compensation details of a user in the BizMerlinHR system. It requires authentication via a user ID and API key in the headers. The API accepts several query parameters including 'guid', 'value', 'compensationType', 'userId', 'currencyCode', 'period', 'effectivedate', 'enddate', 'status', and 'notes'. The 'compensationType' parameter specifies the type of compensation, while 'period' defines the time period for the compensation. The API returns a 201 response with a GUID and message upon successful update, or a 401 response if unauthorized.
Input Fields: Input Fields
Output Fields: Output Fields

Update User Information

ID: post_update_user_information
Operation: write
Entities: user, note, location
Summary: The Update User Information API allows updating various details of a user in the system. It requires authentication through a user ID and API key in the headers. The user can be identified using one of the unique keys: userId, email, empId, or guid. The API accepts various query parameters to update user details such as first name, last name, email, phone numbers, job grade, and more. The response will be a 200 status with an empty object on success or a 401 status with an unauthorized message if authentication fails.
Input Fields: Input Fields
Output Fields: Output Fields

Update User Training Status

ID: post_update_user_training_status
Operation: write
Entities: user, status, training
Summary: The Update User Training Status API allows clients to update the status of a user's training session. It requires the user ID and API key in the headers for authentication. The status and user training ID must be provided as query parameters. The API returns a success message upon successful update, or an error message if there is an issue with authentication or if a conflict occurs during the update process.
Input Fields: Input Fields
Output Fields: Output Fields

Upload Candidate Resume

ID: post_upload_candidate_resume
Operation: write
Entities: resume, candidate
Summary: The Upload Candidate Resume API allows users to upload a candidate's resume in PDF format. The API requires authentication through a user ID and an API key, both of which must be included in the request headers. The request body must contain the PDF resume file encoded in binary format. Upon successful upload, the API returns a message indicating success. If authentication fails, an unauthorized message is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Upload User Profile Picture

ID: post_upload_user_profile_picture
Operation: write
Entities: user, profile picture
Summary: This API endpoint allows users to upload a profile picture for a specified user ID. The request requires authentication via headers, including 'userid' and 'x-api-key'. The request body must be in 'multipart/form-data' format and include the 'file' (the profile picture) and 'userid' (the ID of the user whose profile picture is being updated). Upon successful upload, the API returns a response containing the image name, a success message, and a confirmation message. If unauthorized, a 403 error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Edit Announcement

ID: put_edit_announcement
Operation: write
Entities: announcement
Summary: The Edit Announcement API allows users to edit an existing announcement by providing the announcement ID, title, description, optional URL, and status. The API requires authentication using a user ID and API key in the headers. The status parameter can be set to 'A' for Active, 'D' for Draft, or 'I' for Archive. A successful request returns a message indicating the announcement was edited successfully. Unauthorized requests or conflicts return a failure message.
Input Fields: Input Fields
Output Fields: Output Fields