Service Directory > v32.1 > Recruiting > Put_Background_Check
 

Operation: Put_Background_Check

Load 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: Put_Background_Check_Request

Request to update the status of a Background Check on a person. This operation assumes that the Background Check is using a Background Check Package.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Dynamic_Business_Process_Parameters  Dynamic_Business_Process_Parameters  [0..1]  Container for the processing options for a dynamic business process. If no options are submitted, the process does not move to the next stage or disposition. 
Validation Description
The next step or disposition chosen is invalid for the job application process.   
 
Background_Check_Data  Background_Check_Data  [1..1]  Contains Background Check Information 
Validation Description
You cannot update the Background Check Status for yourself.   
Automatically complete cannot be specified for a background check process that is part of a job application process. Specify the next step or disposition step instead.   
Test belongs to a different Background Check Package or there is no Background Check Package defined for the event.   
There is another background check process in progress for this recipient.   
Specify a package if initiating a new background check process.   
A pre-hire or a worker must exist to initiate a background check. If this is run for a candidate, make sure the candidate is in either the offer or background check stage before initiating a background check.   
 
Validation Description
Move Forward or Decline cannot be specified for a background check that is not part of a job application process.   
top
 

Response Element: Put_Background_Check_Response

The Event modified in this operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Background_Check_EventObject  [0..1]  Event Reference   
top
 

Business_Process_Parameters

part of: Put_Background_Check_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters, Dynamic_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_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  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
 

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

part of: Business_Process_Attachment_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  Event_Attachment_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Event_Attachment_CategoryObjectID

part of: Event_Attachment_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Document_Category__Workday_Owned__ID, Document_Category_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
 

Dynamic_Business_Process_Parameters

part of: Put_Background_Check_Request
Container for the processing options for a dynamic business process. If no options are submitted, the process does not move to the next stage or disposition.
 
Parameter name Type/Value Cardinality Description Validations
Next_Step_Reference [Choice]   Workflow_StepObject  [1..1]  Sends the dynamic business process to the next specified sub-process. This must be a valid next stage based off the current stage of the dynamic business process and the allowed next steps in its definition.   
Disposition_Step_Reference [Choice]   Workflow_StepObject  [1..1]  The disposition step for the dynamic business process. This must be a valid disposition step for the current stage of the business process according to the business process definition.   
Comment_Data  Business_Process_Comment_Data  [0..*]  Captures a comment for the Business Process.   
Validation Description
The next step or disposition chosen is invalid for the job application process.   
top
 

Workflow_StepObject

part of: Dynamic_Business_Process_Parameters, Dynamic_Business_Process_Parameters
 
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  Workflow_StepObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Workflow_StepObjectID

part of: Workflow_StepObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Workflow_Step_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_Data

part of: Put_Background_Check_Request
Wrapper element for Background Check data.
 
Parameter name Type/Value Cardinality Description Validations
Recipient_Reference [Choice]   RoleObject  [1..1]  Reference to a candidate, worker, or pre-hire.   
Event_Reference [Choice]   Background_Check_EventObject  [1..1]  Reference to the Background Check Event.   
Background_Check_Status_Data  Background_Check_Overall_Status_Data  [0..1]  Reference to the Background Check Event. 
Validation Description
Background check status ([status]) is not valid.   
Background check status ([status]) is not valid.   
 
Package_Reference_Data  Package_Reference_Data  [0..1]  Data for the Background Check Package results. 
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 results of each 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.   
 
Validation Description
You cannot update the Background Check Status for yourself.   
Automatically complete cannot be specified for a background check process that is part of a job application process. Specify the next step or disposition step instead.   
Test belongs to a different Background Check Package or there is no Background Check Package defined for the event.   
There is another background check process in progress for this recipient.   
Specify a package if initiating a new background check process.   
A pre-hire or a worker must exist to initiate a background check. If this is run for a candidate, make sure the candidate is in either the offer or background check stage before initiating a background check.   
top
 

RoleObject

part of: Background_Check_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  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
 

Background_Check_EventObject

part of: Put_Background_Check_Response, Background_Check_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_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_Overall_Status_Data

part of: Background_Check_Data
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_Data
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_Data
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
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Workflow_StepReferenceEnumeration

part of: Workflow_StepObjectID
Base Type
string
top
 

RoleReferenceEnumeration

part of: RoleObjectID
Base Type
string
top
 

Background_Check_EventReferenceEnumeration

part of: Background_Check_EventObjectID
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