latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Manage-Changes

manage changes detail

Scopes: export_enrollment

get/v{version}/manage-changes-detail

Path parameters

versionstring required

Query parameters

employee_idstring required

The employee id.

fromstring date-time

The date and time to begin from, inclusive.

tostring date-time

The date and time to begin from, inclusive. The maximum time period allowed is 3 months.

date_lookup_field'LastModifiedOn' | 'LastSummarizedOn'

The date field to perform the lookup on for the from and to values.

Response

Success

changed_bystring[]

A collection of the types of modifiers who made changes.

change_typesstring[]

detail_urlstring

The URL to call for the manage changes.

Example response

{
  "employee": {
    "birth_date": "yyyy-MM-dd",
    "status_effective_date": "yyyy-MM-dd",
    "latest_hire_date": "yyyy-MM-dd",
    "compensation_start_date": "yyyy-MM-dd",
    "compensation_end_date": "yyyy-MM-dd",
    "benefit_eligible_date": "yyyy-MM-dd",
    "hire_date": "yyyy-MM-dd",
    "termination_date": "yyyy-MM-dd",
    "cobra_date": "yyyy-MM-dd",
    "retire_date": "yyyy-MM-dd",
    "death_date": "yyyy-MM-dd",
    "original_hire_date": "yyyy-MM-dd",
    "cobra_end_date": "yyyy-MM-dd",
    "salary_effective_date": "yyyy-MM-dd"
  },
  "dependents": [
    {
      "birth_date": "yyyy-MM-dd",
      "graduation_date": "yyyy-MM-dd",
      "cobra_start_date": "yyyy-MM-dd",
      "cobra_end_date": "yyyy-MM-dd"
    }
  ],
  "enrollment_changes": [
    {
      "new_value": {
        "effective_date": "yyyy-MM-dd",
        "signature_date": "yyyy-MM-dd",
        "original_effective_date": "yyyy-MM-dd",
        "life_event_date": "yyyy-MM-dd",
        "coverages": [
          {
            "effective_date": "yyyy-MM-dd",
            "termination_date": "yyyy-MM-dd",
            "last_coverage_date": "yyyy-MM-dd",
            "life_event": {
              "date": "yyyy-MM-dd",
              "create_date": "yyyy-MM-dd",
              "last_modified_date": "yyyy-MM-dd"
            }
          }
        ],
        "plan": {
          "start_date": "yyyy-MM-dd",
          "end_date": "yyyy-MM-dd"
        },
        "activity_date": "yyyy-MM-dd",
        "change_date": "yyyy-MM-dd"
      },
      "old_value": {
        "effective_date": "yyyy-MM-dd",
        "signature_date": "yyyy-MM-dd",
        "original_effective_date": "yyyy-MM-dd",
        "life_event_date": "yyyy-MM-dd",
        "coverages": [
          {
            "effective_date": "yyyy-MM-dd",
            "termination_date": "yyyy-MM-dd",
            "last_coverage_date": "yyyy-MM-dd",
            "life_event": {
              "date": "yyyy-MM-dd",
              "create_date": "yyyy-MM-dd",
              "last_modified_date": "yyyy-MM-dd"
            }
          }
        ],
        "plan": {
          "start_date": "yyyy-MM-dd",
          "end_date": "yyyy-MM-dd"
        },
        "activity_date": "yyyy-MM-dd",
        "change_date": "yyyy-MM-dd"
      }
    }
  ]
}