Service Directory > v31.2 > Recruiting > Put_Background_Check_Package
 

Operation: Put_Background_Check_Package

Web service task to create or update background check packages.


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

Element containing request attributes, Background Check Package reference, and test details.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Indicates if the request is an add only, not an update.   
Background_Check_Package_Reference  Background_Check_PackageObject  [0..1]  Reference of the Background Check Package.   
Background_Check_Package_Data  Background_Check_Package_Data  [1..1]  Element that contains the Background Check Package details. 
Validation Description
Reference Ids must be unique for each Background Check Package.   
[name] already exists.   
 
Validation Description
The Web Service is set to Add Only; but the Background Check Package already exists.   
top
 

Response Element: Put_Background_Check_Package_Response

Element containing the response of the request to create or update a Background Check Package.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Background_Check_Package_Reference  Background_Check_PackageObject  [0..1]  Reference to the Background Check Package.   
top
 

Background_Check_PackageObject

part of: Put_Background_Check_Package_Request, Put_Background_Check_Package_Response
 
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
 

Background_Check_Package_Data

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