API Response Payloads

This page details the response payloads you will receive when interacting with the Employee Management API, specifically focusing on the processing status and error messages related to upserting employee data.

Initial Response:

When you submit an UpsertEmployeeRequest, the API returns an initial response indicating that your request has been added to the processing queue along with a RequestID.

Structure

csharpCopy codepublic class UpsertEmployeeResponse
{
    public ulong UpsertEmployeeRequestId { get; set; }
    public DateTime AddedToProcessingQueueUtc { get; set; }
}

Fields

• UpsertEmployeeRequestId (ulong): A unique identifier for the upsert request.

• AddedToProcessingQueueUtc (DateTime): The UTC timestamp when the request was added to the processing queue.

Processing and Error Response

After the initial submission, the API processes the request. The result, including any errors encountered, is provided in the ProcessingUpsertEmployeeResponse, which is sent back via webhook and can be retrieved through an endpoint.

Structure

csharpCopy codepublic class ProcessingUpsertEmployeeResponse
{
    public ulong UpsertEmployeeRequestId { get; set; }
    public DateTime AddedToProcessingQueueUtc { get; set; }
    public DateTime? ProcessedUtc { get; set; }
    public ushort Status { get; set; } // 1 - Pending, 2 - Currently Processing, 3 - Completed (no errors), 4 - Completed (with errors)
    public ulong? EmployeeId { get; set; }
    public ushort? EmployeeStatus { get; set; } // 1 - Active Staff Management, 2 - Archived, 3 - Candidate
    public string? PosIdentifier { get; set; }
    public ulong? SupervisorEmployeeId { get; set; }

    public bool? ActionUpsertInFlaikSuccessful { get; set; }
    public bool? ActionUpsertPOSPersonSuccessful { get; set; }
    public bool? ActionUpsertPOSEmployeeSuccessful { get; set; }
    public bool? ActionUpsertPOSInstructorSuccessful { get; set; }

    public string? ActionUpsertInFlaikErrorMessage { get; set; }
    public string? ActionUpsertPOSPersonErrorMessage { get; set; }
    public string? ActionUpsertPOSEmployeeErrorMessage { get; set; }
    public string? ActionUpsertPOSInstructorErrorMessage { get; set; }
}

Fields

• UpsertEmployeeRequestId (ulong): The unique identifier for the original upsert request.

• AddedToProcessingQueueUtc (DateTime): The UTC timestamp when the request was added to the processing queue.

• ProcessedUtc (DateTime?): The UTC timestamp when the request was processed. null if still processing.

• Status (ushort): Indicates the processing status:

  • 1: Pending

  • 2: Currently Processing

  • 3: Completed (no errors)

  • 4: Completed (with errors)

• EmployeeId (ulong?): The unique ID of the employee if available.

• EmployeeStatus (ushort?): Indicates the employee's status:

  • 1: Active Staff Management

  • 2: Archived (removed from staff management)

  • 3: Candidate (not yet in Staff Management, in a Talent pool)

• PosIdentifier (string?): The identifier for the employee in the POS system.

• SupervisorEmployeeId (ulong?): The unique ID of the supervisor employee if available.

Action Success Flags

• ActionUpsertInFlaikSuccessful (bool?): Indicates if the upsert in flaik was successful.

• ActionUpsertPOSPersonSuccessful (bool?): Indicates if the upsert of the person data in the POS was successful.

• ActionUpsertPOSEmployeeSuccessful (bool?): Indicates if the upsert of the employee data in the POS was successful.

• ActionUpsertPOSInstructorSuccessful (bool?): Indicates if the upsert of the instructor data in the POS was successful.

Error Messages

• ActionUpsertInFlaikErrorMessage (string?): Error message if the upsert in flaik failed.

• ActionUpsertPOSPersonErrorMessage (string?): Error message if the upsert of the person data in the POS failed.

• ActionUpsertPOSEmployeeErrorMessage (string?): Error message if the upsert of the employee data in the POS failed.

• ActionUpsertPOSInstructorErrorMessage (string?): Error message if the upsert of the instructor data in the POS failed.