Service Directory > v32.1 > Staffing > Get_Probation_Periods_For_Workers
 

Operation: Get_Probation_Periods_For_Workers

Return Employees Probation Periods


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

Get Probation Periods for a single Worker
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Probation_Periods_For_Workers_Request_References  [1..1]  Contains a single reference to a worker   
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_Probation_Periods_For_Workers_Response

Holds the Get Probation Periods For a Worker Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Probation_Periods_For_Workers_Request_References  [0..1]  Contains a single reference to a worker   
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  Get_Probation_Periods_For_Worker_Response_Data  [0..1]  Contains Probation Periods For Worker   
top
 

Probation_Periods_For_Workers_Request_References

part of: Get_Probation_Periods_For_Workers_Response, Get_Probation_Periods_For_Workers_Request
Contains a single reference to a worker
 
Parameter name Type/Value Cardinality Description Validations
Workers_Reference  WorkerObject  [0..*]  Reference to a Worker   
top
 

WorkerObject

part of: Probation_Periods_For_Worker_Data, Probation_Periods_For_Workers_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  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
 

Response_Filter

part of: Get_Probation_Periods_For_Workers_Response, Get_Probation_Periods_For_Workers_Request
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_Probation_Periods_For_Workers_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
 

Get_Probation_Periods_For_Worker_Response_Data

part of: Get_Probation_Periods_For_Workers_Response
Contains Probation Periods For Worker
 
Parameter name Type/Value Cardinality Description Validations
Probation_Periods_For_Workers  Probation_Periods_For_Workers  [0..*]  Contains Probation Periods For Worker   
top
 

Probation_Periods_For_Workers

part of: Get_Probation_Periods_For_Worker_Response_Data
Contains Probation Periods For Worker
 
Parameter name Type/Value Cardinality Description Validations
Probation_Periods_For_Worker_Reference  Employee_Probation_PeriodObject  [0..1]  Probation Periods For Worker Reference   
Probation_Period_For_Worker_Data  Probation_Periods_For_Worker_Data  [0..*]  Probation Period For Worker Data   
top
 

Employee_Probation_PeriodObject

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

Employee_Probation_PeriodObjectID

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

part of: Probation_Periods_For_Workers
Contains the probation period data for a worker
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Worker Reference   
Position_Reference  Position_ElementObject  [0..1]  Position   
Start_Date  date  [0..1]  Probation Period Start Date   
End_Date  date  [0..1]  End Date   
Extended_End_Date  date  [0..1]  Extended End Date   
Employee_Probation_Period_Type_Reference  Employee_Probation_Period_TypeObject  [0..1]  Probation Period Type Reference   
Probation_Period_Reason_Reference  Employee_Probation_Period_ReasonObject  [0..1]  Probation Period Reason   
Note  string  [0..1]  Note   
Custom_Probation_Period_Duration  decimal (20, 0) >0   [0..1]  Custom Probation Period Duration   
Custom_Probation_Period_Unit_Reference  Date_And_Time_UnitObject  [0..1]  Custom Probation Period Unit   
Extended_Probation_Period_Duration  decimal (20, 0) >0   [0..1]  Extended Probation Period Duration   
Extended_Probation_Period_Unit_Reference  Date_And_Time_UnitObject  [0..1]  Extended Probation Period Unit   
Custom_Review_Probation_Period_Date  date  [0..1]  Review Probation Period Date   
Custom_Review_Probation_Period_Duration  decimal (20, 0) >0   [0..1]  Review Probation Period Duration   
Custom_Review_Probation_Period_Unit_Reference  Date_And_Time_UnitObject  [0..1]  Review Probation Period Unit   
top
 

Position_ElementObject

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

Position_ElementObjectID

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

Employee_Probation_Period_TypeObject

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

Employee_Probation_Period_TypeObjectID

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

Employee_Probation_Period_ReasonObject

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

Employee_Probation_Period_ReasonObjectID

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

Date_And_Time_UnitObject

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

Date_And_Time_UnitObjectID

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

Employee_Probation_PeriodReferenceEnumeration

part of: Employee_Probation_PeriodObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Employee_Probation_Period_TypeReferenceEnumeration

part of: Employee_Probation_Period_TypeObjectID
Base Type
string
top
 

Employee_Probation_Period_ReasonReferenceEnumeration

part of: Employee_Probation_Period_ReasonObjectID
Base Type
string
top
 

Date_And_Time_UnitReferenceEnumeration

part of: Date_And_Time_UnitObjectID
Base Type
string
top