Service Directory > v31.2 > Staffing > Get_Maintain_Probation_Periods_For_Country
 

Operation: Get_Maintain_Probation_Periods_For_Country

Get the Probation Period Rules for a single or many countries.


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

Get Probation Periods for a single or multiple countries
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Probation_Periods_For_Country_Request_References  [0..1]  Get Maintain Probation Periods For Country Request   
Request_Criteria [Choice]   Probation_Periods_For_Country_Request_Criteria  [0..1]  Country/Countries Request 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. 
 
top
 

Response Element: Get_Maintain_Probation_Periods_For_Country_Response

Response contains all Probation Periods that met Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Probation_Periods_For_Country_Request_References  [0..1]  Probation Periods For Country References   
Request_Criteria  Probation_Periods_For_Country_Request_Criteria  [0..1]  Probation Periods For Country Request Criteria   
Response_Data  Probation_Periods_For_Country_Response_Data  [0..1]  Probation Periods For Country Details   
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.   
top
 

Probation_Periods_For_Country_Request_References

part of: Get_Maintain_Probation_Periods_For_Country_Request, Get_Maintain_Probation_Periods_For_Country_Response
Probation Periods For Country References
 
Parameter name Type/Value Cardinality Description Validations
Maintain_Probation_Periods_For_Country_Reference  Probation_Period_Rules_TableObject  [1..*]  Maintain Probation Periods For Country Reference   
top
 

Probation_Period_Rules_TableObject

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

Probation_Period_Rules_TableObjectID

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

Probation_Periods_For_Country_Request_Criteria

part of: Get_Maintain_Probation_Periods_For_Country_Request, Get_Maintain_Probation_Periods_For_Country_Response
Probation Periods For Country Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [0..*]  Single or Multiple Countries   
top
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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_Maintain_Probation_Periods_For_Country_Request, Get_Maintain_Probation_Periods_For_Country_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
 

Probation_Periods_For_Country_Response_Data

part of: Get_Maintain_Probation_Periods_For_Country_Response
Probation Periods For Country Response Data element.
 
Parameter name Type/Value Cardinality Description Validations
Maintain_Probation_Periods_For_Country  Probation_Periods_For_Country_Get_Data  [0..*]  Probation Periods For Country Get Data element.   
top
 

Probation_Periods_For_Country_Get_Data

part of: Probation_Periods_For_Country_Response_Data
Probation Periods For Country Get Data element.
 
Parameter name Type/Value Cardinality Description Validations
Maintain_Probation_Periods_For_Country_Reference  Probation_Period_Rules_TableObject  [0..1]  Country Reference   
Maintain_Probation_Periods_For_Country_Data  Maintain_Probation_Periods_For_Country_Data  [0..1]  Contains Maintain Probation Period for Country data 
Validation Description
You can't add more than [limit] rows.   
 
top
 

Maintain_Probation_Periods_For_Country_Data

part of: Probation_Periods_For_Country_Get_Data
Contains Maintain Probation Period for Country data
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [1..1]  Country Reference   
Probation_Period_For_Country_Data  Probation_Period_For_Country_Data  [0..*]  Probation Periods For Country Details 
Validation Description
Select a Unit for the row.   
 
Validation Description
You can't add more than [limit] rows.   
top
 

Probation_Period_For_Country_Data

part of: Maintain_Probation_Periods_For_Country_Data
Probation Period For Country Data
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [0..1]  Order on Maintain Probation Periods by Country table   
Probation_Period_Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  Probation Period Eligibility Rule   
Probation_Period_Duration  decimal (20, 0) >0   [0..1]  Probation Period Duration   
Probation_Period_Unit_Reference  Unique_IdentifierObject  [0..1]  Probation Period Unit   
Maximum_Probation_Period_Data  Maximum_Probation_Period_Data  [0..*]  Maximum Probation Period Data 
Validation Description
Select a Maximum Probation Period Unit for the row.   
 
Review_Probation_Period_Data  Review_Probation_Period_Data  [0..*]  Review Probation Period Data 
Validation Description
Select a Schedule Review Unit for the row.   
 
Inactive  boolean  [0..1]  Probation Period Inactive   
Validation Description
Select a Unit for the row.   
top
 

Condition_RuleObject

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

Condition_RuleObjectID

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

Unique_IdentifierObject

part of: Probation_Period_For_Country_Data, Review_Probation_Period_Data, Maximum_Probation_Period_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  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
 

Maximum_Probation_Period_Data

part of: Probation_Period_For_Country_Data
Maximum Probation Period Data
 
Parameter name Type/Value Cardinality Description Validations
Maximum_Probation_Duration  decimal (20, 0) >0   [0..1]  Probation Period Duration   
Maximum_Probation_Unit_Reference  Unique_IdentifierObject  [0..1]  Probation Period Unit   
Validation Description
Select a Maximum Probation Period Unit for the row.   
top
 

Review_Probation_Period_Data

part of: Probation_Period_For_Country_Data
Review Probation Period Data
 
Parameter name Type/Value Cardinality Description Validations
Review_Probation_Duration  decimal (20, 0) >0   [0..1]  Probation Period Duration 
Validation Description
You can’t set the default Schedule Review without a Duration and Unit for the default Probation Period.   
 
Review_Probation_Unit_Reference  Unique_IdentifierObject  [0..1]  Probation Period Unit   
Validation Description
Select a Schedule Review Unit for the row.   
top
 

Response_Results

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

Probation_Period_Rules_TableReferenceEnumeration

part of: Probation_Period_Rules_TableObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top