Service Directory > v31.2 > Recruiting > Get_Background_Check_Packages
 

Operation: Get_Background_Check_Packages

Returns information for Background Check Packages specified in the request.


@ - 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_Packages_Request

Contains request reference, criteria, filter and response group for getting Background Check Packages data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Background_Check_Package_Request_References  [0..1]  Contains Background Check Package references that are requested to be 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. 
 
Response_Group  Background_Check_Package_Response_Group  [0..1]  Element containing Background Check Package response grouping options.   
top
 

Response Element: Get_Background_Check_Packages_Response

Wrapper element containing Background Check Package Response Data for requested references or criteria and for requested response group.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Background_Check_Package_Request_References  [0..1]  Contains Background Check Package references   
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_Group  Background_Check_Package_Response_Group  [0..1]  Documentation Element containing Background Check Package response grouping options   
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_Package_Response_Data  [0..1]  Contains Background Check Package response data for the requested packages   
top
 

Background_Check_Package_Request_References

part of: Get_Background_Check_Packages_Request, Get_Background_Check_Packages_Response
Contains Background Check Package references
 
Parameter name Type/Value Cardinality Description Validations
Background_Check_Package_Reference  Background_Check_PackageObject  [1..*]  Background Check Package references   
top
 

Background_Check_PackageObject

part of: Background_Check_Package_Request_References, Background_Check_Package
 
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
 

Response_Filter

part of: Get_Background_Check_Packages_Request, Get_Background_Check_Packages_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
 

Background_Check_Package_Response_Group

part of: Get_Background_Check_Packages_Request, Get_Background_Check_Packages_Response
Documentation Element containing Background Check Package response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates if reference should be included in response.   
top
 

Response_Results

part of: Get_Background_Check_Packages_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_Package_Response_Data

part of: Get_Background_Check_Packages_Response
Wrapper element containing Background Check Package Response Data for requested references or criteria and for requested response group.
 
Parameter name Type/Value Cardinality Description Validations
Background_Check_Package  Background_Check_Package  [0..*]  Contains Background Check Package details.   
top
 

Background_Check_Package

part of: Background_Check_Package_Response_Data
Contains Background Check Package reference and details.
 
Parameter name Type/Value Cardinality Description Validations
Background_Check_Package_Reference  Background_Check_PackageObject  [0..1]  Reference to Background Check Package for the related Background Check Package Data element.   
Background_Check_Package_Data  Background_Check_Package_Data  [0..1]  Element containing the Background Check Package information and contained tests. 
Validation Description
Reference Ids must be unique for each Background Check Package.   
[name] already exists.   
 
top
 

Background_Check_Package_Data

part of: Background_Check_Package
Element containing the Background Check Package information and contained tests.
 
Parameter name Type/Value Cardinality Description Validations
Background_Check_Package  string (50)   [1..1]  Name of the Background Check Package.   
Package_Reference_ID  string  [0..1]  Reference ID of the Background Check Package.   
Background_Check_Description  string  [0..1]  Description of the Background Check Package.   
Inactive  boolean  [0..1]  Indicates if the Background Check Package is inactive.   
Background_Check_Test  Background_Check_Package_Test  [0..*]  Information about the Background Check Package Test.   
Validation Description
Reference Ids must be unique for each Background Check Package.   
[name] already exists.   
top
 

Background_Check_Package_Test

part of: Background_Check_Package_Data
Element containing Background Check Package data and related tests.
 
Parameter name Type/Value Cardinality Description Validations
Background_Check_Package_Test_Reference_ID  string  [0..1]  Reference ID of the Background Check Package Test to update. 
Validation Description
Test belongs to a different Background Check Package.   
 
Background_Check_Test_Data  Background_Check_Package_Test_Data  [1..1]  Contains information about the Background Check Package Test.   
top
 

Background_Check_Package_Test_Data

part of: Background_Check_Package_Test
Element containing the background test details.
 
Parameter name Type/Value Cardinality Description Validations
Background_Check_Test  string (50)   [1..1]  Name of the Background Check Package Test.   
Test_Reference  string  [0..1]  Reference ID of Background Check Package Test. 
Validation Description
Reference Ids must be unique for each Background Check Package Test.  Validation enforcing that reference IDs must be unique for each Background Check Package Test. 
If you are creating a new background check package test, the Background Check Package Test Reference ID and Test Reference ID must match.  If the test is new, then the reference IDs should match if they both exist. Otherwise, if they do match, or if either one is missing, or if the Background Check Package Test Reference ID refers to an existing test, then either create the test with the single reference ID, or update the existing one. 
 
Background_Check_Test_Description  string  [0..1]  Description of the Background Check Package Test.   
top
 

Background_Check_PackageReferenceEnumeration

part of: Background_Check_PackageObjectID
Base Type
string
top