Retrieve Past or Future Worker Details
To retrieve past or future worker details:
- Perform a GET operation on the workers API using query parameters.
- Verify the details returned in the response.
Example URL
Use this resource URL format.
GET
/hcmRestApi/resources/11.13.18.05/workers?q=PersonNumber='955160008191542'&expand=workRelationships.assignments&effectiveDate=2020-01-01Example Header
Provide the header.
REST-Framework-Version : 4Example Response
Here's an example of the response body in JSON format.
{
"items": [
{
"PersonId": 1559921815,
"PersonNumber": "955160008191542",
"CorrespondenceLanguage": null,
"BloodType": "A+",
"DateOfBirth": "1997-01-01",
"DateOfDeath": null,
"CountryOfBirth": null,
"RegionOfBirth": null,
"TownOfBirth": null,
"ApplicantNumber": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2019-06-07T15:36:26+00:00",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"LastUpdateDate": "2019-06-07T15:36:29.607+00:00",
"workRelationships": {
"items": [
{
"PeriodOfServiceId": 300100180001240,
"LegislationCode": "US",
"LegalEntityId": 40010,
"LegalEmployerName": "Vision Corporation",
"WorkerType": "E",
"PrimaryFlag": true,
"StartDate": "2019-06-02",
"LegalEmployerSeniorityDate": null,
"EnterpriseSeniorityDate": null,
"OnMilitaryServiceFlag": false,
"WorkerNumber": null,
"ReadyToConvertFlag": null,
"TerminationDate": "2019-10-24",
"NotificationDate": "2019-10-24",
"LastWorkingDate": null,
"RevokeUserAccess": "A",
"RecommendedForRehire": "ORA_NS",
"RecommendationReason": null,
"RecommendationAuthorizedByPersonId": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2019-06-07T15:36:27.057+00:00",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"LastUpdateDate": "2019-06-11T21:44:51.002+00:00",
"assignments": {
"items": [
{
"AssignmentId": 300100180063354,
"AssignmentNumber": "E955160008191542-3",
"AssignmentName": "E955160008191542-3",
"ActionCode": "TEMP_ASG",
"ReasonCode": null,
"EffectiveStartDate": "2019-06-25",
"EffectiveEndDate": "2020-06-25",
"EffectiveSequence": 1,
"EffectiveLatestChange": "Y",
"BusinessUnitId": 300100024264603,
"BusinessUnitName": "Vision Central",
"AssignmentType": "E",
"AssignmentStatusTypeId": 100010026278190,
"AssignmentStatusTypeCode": "ACTIVE_PROCESS",
"AssignmentStatusType": "ACTIVE",
"SystemPersonType": "EMP",
"UserPersonTypeId": 13,
"UserPersonType": "Employee",
"ProposedUserPersonTypeId": null,
"ProposedUserPersonType": null,
"ProjectedStartDate": null,
"ProjectedEndDate": null,
"PrimaryFlag": false,
"PrimaryAssignmentFlag": false,
"PositionId": null,
"PositionCode": null,
"SynchronizeFromPositionFlag": true,
"JobId": null,
"JobCode": null,
"GradeId": null,
"GradeCode": null,
"GradeLadderId": null,
"GradeLadderName": null,
"GradeStepEligibilityFlag": true,
"GradeCeilingStepId": null,
"GradeCeilingStep": null,
"DepartmentId": null,
"DepartmentName": null,
"ReportingEstablishmentId": null,
"ReportingEstablishmentName": null,
"LocationId": null,
"LocationCode": null,
"WorkAtHomeFlag": false,
"AssignmentCategory": null,
"WorkerCategory": null,
"PermanentTemporary": null,
"FullPartTime": null,
"ManagerFlag": false,
"HourlySalariedCode": null,
"NormalHours": null,
"Frequency": null,
"StartTime": null,
"EndTime": null,
"SeniorityBasis": "ORA_PER_SNDT_DAYS",
"ProbationPeriod": null,
"ProbationPeriodUnit": null,
"ProbationEndDate": null,
"NoticePeriod": null,
"NoticePeriodUOM": null,
"WorkTaxAddressId": null,
"ExpenseCheckSendToAddress": null,
"RetirementAge": null,
"RetirementDate": null,
"LabourUnionMemberFlag": null,
"UnionId": null,
"UnionName": null,
"BargainingUnitCode": null,
"CollectiveAgreementId": null,
"CollectiveAgreementName": null,
"InternalBuilding": null,
"InternalFloor": null,
"InternalOfficeNumber": null,
"InternalMailstop": null,
"DefaultExpenseAccount": null,
"PeopleGroup": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2019-06-11T22:14:29.463+00:00",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"LastUpdateDate": "2019-06-12T18:43:27.614+00:00",
"links": [...]
},
{
"AssignmentId": 300100180001246,
"AssignmentNumber": "E955160008191542",
"AssignmentName": "REST_AUTO_JobCS",
"ActionCode": "GLB_TRANSFER",
"ReasonCode": null,
"EffectiveStartDate": "2019-10-25",
"EffectiveEndDate": "4712-12-31",
"EffectiveSequence": 1,
"EffectiveLatestChange": "Y",
"BusinessUnitId": 300100024264603,
"BusinessUnitName": "Vision Central",
"AssignmentType": "E",
"AssignmentStatusTypeId": 100010026278193,
"AssignmentStatusTypeCode": "INACTIVE_PROCESS",
"AssignmentStatusType": "INACTIVE",
"SystemPersonType": "EMP",
"UserPersonTypeId": 13,
"UserPersonType": "Employee",
"ProposedUserPersonTypeId": null,
"ProposedUserPersonType": null,
"ProjectedStartDate": null,
"ProjectedEndDate": null,
"PrimaryFlag": true,
"PrimaryAssignmentFlag": true,
"PositionId": 300100127013307,
"PositionCode": "REST_AUTO_Position_P1_Code",
"SynchronizeFromPositionFlag": true,
"JobId": 300100126526760,
"JobCode": "REST_AUTO_JobCS_Code",
"GradeId": null,
"GradeCode": null,
"GradeLadderId": null,
"GradeLadderName": null,
"GradeStepEligibilityFlag": true,
"GradeCeilingStepId": null,
"GradeCeilingStep": null,
"DepartmentId": 300100126527002,
"DepartmentName": "REST_AUTO_OrganizationCS",
"ReportingEstablishmentId": null,
"ReportingEstablishmentName": null,
"LocationId": 300100126526960,
"LocationCode": "REST_AUTO_LocationCS_Code",
"WorkAtHomeFlag": false,
"AssignmentCategory": null,
"WorkerCategory": null,
"PermanentTemporary": "R",
"FullPartTime": "FULL_TIME",
"ManagerFlag": false,
"HourlySalariedCode": null,
"NormalHours": 45,
"Frequency": "W",
"StartTime": null,
"EndTime": null,
"SeniorityBasis": "ORA_PER_SNDT_DAYS",
"ProbationPeriod": null,
"ProbationPeriodUnit": null,
"ProbationEndDate": null,
"NoticePeriod": null,
"NoticePeriodUOM": null,
"WorkTaxAddressId": null,
"ExpenseCheckSendToAddress": null,
"RetirementAge": null,
"RetirementDate": null,
"LabourUnionMemberFlag": null,
"UnionId": null,
"UnionName": null,
"BargainingUnitCode": null,
"CollectiveAgreementId": null,
"CollectiveAgreementName": null,
"InternalBuilding": null,
"InternalFloor": null,
"InternalOfficeNumber": null,
"InternalMailstop": null,
"DefaultExpenseAccount": null,
"PeopleGroup": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2019-06-07T15:36:27.203+00:00",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"LastUpdateDate": "2019-06-11T21:44:52.078+00:00",
"links": [...]
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [...]
},
"links": [...]
},
{
"PeriodOfServiceId": 300100180062678,
"LegislationCode": "US",
"LegalEntityId": 300100014494062,
"LegalEmployerName": "Vision City LE",
"WorkerType": "E",
"PrimaryFlag": true,
"StartDate": "2019-10-25",
"LegalEmployerSeniorityDate": null,
"EnterpriseSeniorityDate": null,
"OnMilitaryServiceFlag": false,
"WorkerNumber": null,
"ReadyToConvertFlag": null,
"TerminationDate": null,
"NotificationDate": null,
"LastWorkingDate": null,
"RevokeUserAccess": null,
"RecommendedForRehire": "ORA_NS",
"RecommendationReason": null,
"RecommendationAuthorizedByPersonId": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2019-06-11T21:44:48.524+00:00",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"LastUpdateDate": "2019-06-11T21:46:12.680+00:00",
"assignments": {
"items": [
{
"AssignmentId": 300100180062684,
"AssignmentNumber": "E955160008191542-2",
"AssignmentName": "E955160008191542-2",
"ActionCode": "GLB_TRANSFER",
"ReasonCode": null,
"EffectiveStartDate": "2019-10-25",
"EffectiveEndDate": "4712-12-31",
"EffectiveSequence": 1,
"EffectiveLatestChange": "Y",
"BusinessUnitId": 300100024264603,
"BusinessUnitName": "Vision Central",
"AssignmentType": "E",
"AssignmentStatusTypeId": 100010026278190,
"AssignmentStatusTypeCode": "ACTIVE_PROCESS",
"AssignmentStatusType": "ACTIVE",
"SystemPersonType": "EMP",
"UserPersonTypeId": 13,
"UserPersonType": "Employee",
"ProposedUserPersonTypeId": null,
"ProposedUserPersonType": null,
"ProjectedStartDate": null,
"ProjectedEndDate": null,
"PrimaryFlag": true,
"PrimaryAssignmentFlag": true,
"PositionId": null,
"PositionCode": null,
"SynchronizeFromPositionFlag": true,
"JobId": null,
"JobCode": null,
"GradeId": null,
"GradeCode": null,
"GradeLadderId": null,
"GradeLadderName": null,
"GradeStepEligibilityFlag": true,
"GradeCeilingStepId": null,
"GradeCeilingStep": null,
"DepartmentId": null,
"DepartmentName": null,
"ReportingEstablishmentId": null,
"ReportingEstablishmentName": null,
"LocationId": null,
"LocationCode": null,
"WorkAtHomeFlag": false,
"AssignmentCategory": null,
"WorkerCategory": null,
"PermanentTemporary": null,
"FullPartTime": null,
"ManagerFlag": false,
"HourlySalariedCode": null,
"NormalHours": null,
"Frequency": null,
"StartTime": null,
"EndTime": null,
"SeniorityBasis": "ORA_PER_SNDT_DAYS",
"ProbationPeriod": null,
"ProbationPeriodUnit": null,
"ProbationEndDate": null,
"NoticePeriod": null,
"NoticePeriodUOM": null,
"WorkTaxAddressId": null,
"ExpenseCheckSendToAddress": null,
"RetirementAge": null,
"RetirementDate": null,
"LabourUnionMemberFlag": null,
"UnionId": null,
"UnionName": null,
"BargainingUnitCode": null,
"CollectiveAgreementId": null,
"CollectiveAgreementName": null,
"InternalBuilding": null,
"InternalFloor": null,
"InternalOfficeNumber": null,
"InternalMailstop": null,
"DefaultExpenseAccount": null,
"PeopleGroup": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2019-06-11T21:44:49.584+00:00",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"LastUpdateDate": "2019-06-11T21:46:13.087+00:00",
"links": [
...]
}
]
}