Service Directory > v32.1 > Recruiting > Get_Background_Check
 

Operation: Get_Background_Check

Retrieve background check results for a Background Check Event.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Background_Check_Request

All the data for requesting details for Background Check Events. This web service operation assumes the Background Check Events use Background Check Package.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Background_Check_Request_References  [0..1]  References to the specific Background Check Events to return.   
Request_Criteria  Background_Check_Request_Criteria  [0..1]  Parameters that let you specify the Background Check Events that are returned.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Background_Check_Response

Data for Background Check Events. Used for Background Check Events that have Background Check Packages.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Background_Check_Request_References  [0..1]  Background Check Event request references.   
Request_Criteria  Background_Check_Request_Criteria  [0..1]  Utilize the Request Criteria element to filter the returned Background Check Events to those Payees that meet ALL of the criteria.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Background_Check_Response_Data  [0..1]  Data for Background Check Events. Used for Background Check Events that have Background Check Packages.   
top
 

Background_Check_Request_References

part of: Get_Background_Check_Request, Get_Background_Check_Response
Background Check Event request references.
 
Parameter name Type/Value Cardinality Description Validations
Event_Reference  Background_Check_EventObject  [0..*]  Background Check Event request references.   
top
 

Background_Check_EventObject

part of: Background_Check_Request_References, Background_Check_Event
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Background_Check_EventObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Background_Check_EventObjectID

part of: Background_Check_EventObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Background_Check_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Background_Check_Request_Criteria

part of: Get_Background_Check_Request, Get_Background_Check_Response
Utilize the Request Criteria element to filter the returned Background Check Events to those Payees that meet ALL of the criteria.
 
Parameter name Type/Value Cardinality Description Validations
Requester_Reference  WorkerObject  [0..1]  Reference to the background check submitter.   
Recipient_Reference  RoleObject  [0..1]  Reference to a candidate, worker, or pre-hire.   
Submission_Date  date  [0..1]  Date the background check event was initiated.   
Workflow_State_Reference  Unique_IdentifierObject  [0..1]  The reference to the State of the Workflow Event. Supports WIDs only.   
Package_Selected  boolean  [0..1]  List only those background checks that include a background check package.   
Field_And_Parameter_Criteria_Data  Field_And_Parameter_Criteria_Data  [0..1]  Field Result Request Criteria   
top
 

WorkerObject

part of: Background_Check_Request_Criteria, Background_Check_Event
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

RoleObject

part of: Background_Check_Request_Criteria, Background_Check_Event
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  RoleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

RoleObjectID

part of: RoleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Affiliate_ID, Academic_Contact_ID, Academic_Person_ID, Applicant_ID, Beneficiary_ID, Business_Entity_Contact_ID, Candidate_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Dependent_ID, Emergency_Contact_ID, Employee_ID, Extended_Enterprise_Contact_Person_ID, Extended_Enterprise_Learner_ID, External_Committee_Member_ID, Former_Worker_ID, Instructor_ID, Learning_Assessor_ID, Learning_Instructor_ID, LearningUserName, Organization_Reference_ID, Recruiting_Agency_User_ID, RecruitingUserName, Region_Reference_ID, Service_Center_Representative_ID, Student_ID, Student_Proxy_ID, Student_Recruiter_ID, StudentUserName, SupplierUserName, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal, WorkdayUserName  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Unique_IdentifierObject

part of: Background_Check_Request_Criteria, Background_Check_Event
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Field_And_Parameter_Criteria_Data

part of: Background_Check_Request_Criteria
Field Result Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Provider_Reference  External_Field_and_Parameter_Initialization_ProviderObject  [1..*]  Field And Parameter Initialization Provider Reference   
top
 

External_Field_and_Parameter_Initialization_ProviderObject

part of: Field_And_Parameter_Criteria_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  External_Field_and_Parameter_Initialization_ProviderObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

External_Field_and_Parameter_Initialization_ProviderObjectID

part of: External_Field_and_Parameter_Initialization_ProviderObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_System_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Background_Check_Request, Get_Background_Check_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Background_Check_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Background_Check_Response_Data

part of: Get_Background_Check_Response
Data for Background Check Events. Used for Background Check Events that have Background Check Packages.
 
Parameter name Type/Value Cardinality Description Validations
Background_Check_Event  Background_Check_Event  [0..*]  Details for a Background Check Event   
top
 

Background_Check_Event

part of: Background_Check_Response_Data
Details for a Background Check Event
 
Parameter name Type/Value Cardinality Description Validations
Event_Reference  Background_Check_EventObject  [0..1]  Reference to the Background Check Event.   
Recruiting_Sub_Process  boolean  [0..1]  Indicates whether this Background Check is a sub-process of the Recruiting process.   
Requester_Reference  WorkerObject  [0..1]  Reference to the background check submitter.   
Recipient_Reference  RoleObject  [0..1]  Reference to the screening recipient.   
Requisition_Reference  Job_Requisition_EnabledObject  [0..1]  Reference to the job this test is for.   
Submission_Date  dateTime  [0..1]  Date the background check event was initiated.   
Background_Check_Status_Data  Background_Check_Overall_Status_Data  [0..1]  Wrapper element for Background Check data. 
Validation Description
Background check status ([status]) is not valid.   
Background check status ([status]) is not valid.   
 
Workflow_State_Reference  Unique_IdentifierObject  [0..1]  The reference to the State of the Event.   
Package_Reference_Data  Package_Reference_Data  [0..*]  Details of the Background Check Package. 
Validation Description
Background check status ([status]) is not valid.   
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
Background check status ([status]) is not valid.   
 
Test_Reference_Data  Test_Reference_Data  [0..*]  Data for Background Check Package Test results. 
Validation Description
Background check status ([status]) is not valid.  Only active Background Check Statuses may be selected. 
Background check status ([status]) is not valid.   
 
Document_Field_Result_Data  Document_Field_Result_Data  [0..*]  Result of the evaluation of an External Field based on a contextual instance.   
top
 

Job_Requisition_EnabledObject

part of: Background_Check_Event
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Job_Requisition_EnabledObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Job_Requisition_EnabledObjectID

part of: Job_Requisition_EnabledObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Job_Requisition_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Background_Check_Overall_Status_Data

part of: Background_Check_Event
Wrapper element for Background Check data.
 
Parameter name Type/Value Cardinality Description Validations
Status_Date  date  [1..1]  Background check status date.   
Status_Reference  Background_Check_StatusObject  [1..1]  Background check status.   
Status_Comment  string  [0..1]  Background check status comment.   
Validation Description
Background check status ([status]) is not valid.   
Background check status ([status]) is not valid.   
top
 

Background_Check_StatusObject

part of: Background_Check_Overall_Status_Data, Package_Reference_Data, Test_Reference_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Background_Check_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Background_Check_StatusObjectID

part of: Background_Check_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Background_Check_Status_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Package_Reference_Data

part of: Background_Check_Event
Details of the Background Check Package.
 
Parameter name Type/Value Cardinality Description Validations
@Package_Name  string (50)   [1..1]  Name of the Background Check Package. The name cannot be updated using this operation.   
@Package_Description  string  [1..1]  The description of the Background Check Package. The description cannot be updated using this operation.   
Package_Reference  Background_Check_PackageObject  [0..1]  Reference to the Background Check Package. 
Validation Description
Incorrect Background Check Package for Event. Background Check is for package [package].  Verify the provided Package the same Background Check Package that the event uses. If the criteria bring up zero or more than one event, we have bigger problems to deal with so don't fire the validation. 
 
Status_Reference  Background_Check_StatusObject  [1..1]  Reference to the status for the Background Check Package.   
Results_URL  string  [0..1]  URL to the external provider's results.   
Package_Comment  string  [0..1]  An optional comment.   
Validation Description
Background check status ([status]) is not valid.   
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
Background check status ([status]) is not valid.   
top
 

Background_Check_PackageObject

part of: Package_Reference_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Background_Check_PackageObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Background_Check_PackageObjectID

part of: Background_Check_PackageObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Background_Check_Package_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Test_Reference_Data

part of: Background_Check_Event
Data for Background Check Package Test results.
 
Parameter name Type/Value Cardinality Description Validations
@Test_Name  string (50)   [1..1]  The name of the Background Check Package Test. The name cannot be updated using this operation.   
@Test_Description  string  [1..1]  The description of the Background Check Package Test. The description cannot be updated using this operation.   
Background_Check_Package_Test_Reference  Background_Check_Package_TestObject  [1..1]  Reference to the Background Check Package Test. The Test must be part of the Background Check Package for this Event.   
Status_Reference  Background_Check_StatusObject  [1..1]  Status of the Background Check Package Test.   
Validation Description
Background check status ([status]) is not valid.  Only active Background Check Statuses may be selected. 
Background check status ([status]) is not valid.   
top
 

Background_Check_Package_TestObject

part of: Test_Reference_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Background_Check_Package_TestObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Background_Check_Package_TestObjectID

part of: Background_Check_Package_TestObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Background_Check_Package_Test_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Document_Field_Result_Data

part of: Background_Check_Event
Result of the evaluation of an External Field based on a contextual instance.
 
Parameter name Type/Value Cardinality Description Validations
Field_Reference  Integration_Document_FieldObject  [0..1]  Integration Document Field Reference. Eligibility Criteria element is used in conjunction with Workday delivered integrations.   
Value  string  [0..1]  Value   
top
 

Integration_Document_FieldObject

part of: Document_Field_Result_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Integration_Document_FieldObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Integration_Document_FieldObjectID

part of: Integration_Document_FieldObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_Document_Field_Name, Workday_Integration_Document_Field_Name  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Integration_Document_Name, Workday_Integration_Document_Name  [1..1]  The unique identifier type of a parent object   
top
 

Background_Check_EventReferenceEnumeration

part of: Background_Check_EventObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

RoleReferenceEnumeration

part of: RoleObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

External_Field_and_Parameter_Initialization_ProviderReferenceEnumeration

part of: External_Field_and_Parameter_Initialization_ProviderObjectID
Base Type
string
top
 

Job_Requisition_EnabledReferenceEnumeration

part of: Job_Requisition_EnabledObjectID
Base Type
string
top
 

Background_Check_StatusReferenceEnumeration

part of: Background_Check_StatusObjectID
Base Type
string
top
 

Background_Check_PackageReferenceEnumeration

part of: Background_Check_PackageObjectID
Base Type
string
top
 

Background_Check_Package_TestReferenceEnumeration

part of: Background_Check_Package_TestObjectID
Base Type
string
top
 

Integration_Document_FieldReferenceEnumeration

part of: Integration_Document_FieldObjectID
Base Type
string
top
 

Base Type
string

top