Service Directory > v32.1 > Absence_Management > Get_Time_Off_Plan_Balances
 

Operation: Get_Time_Off_Plan_Balances

This operation retrieves the dynamic Time Off Plan Balances by Worker and Time Off Plan.


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

Get Time Off Plan Balances Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Time_Off_Plan_Balance_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Time_Off_Plan_Balance_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Time_Off_Plan_Balances_Response

Get Time Off Plan Balances Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Time_Off_Plan_Balance_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Time_Off_Plan_Balance_Response_Group  [0..1]  Response Group   
Response_Results  Response_Results  [0..*]  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  Time_Off_Plan_Balance_Response_Data  [0..*]  Time Off Plan Balance Response Data   
top
 

Time_Off_Plan_Balance_Request_Criteria

part of: Get_Time_Off_Plan_Balances_Request, Get_Time_Off_Plan_Balances_Response
Time Off Plan Balance Request Criteria. The intersection of criteria passed in this element is used to create a working set.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  WorkerObject  [0..1]  Employee   
Time_Off_Plan_Reference  Absence_Plan__All_Object  [0..1]  Time Off Plan Reference   
Organization_Reference  OrganizationObject  [0..*]  Organization Reference   
top
 

WorkerObject

part of: Time_Off_Plan_Balance_Request_Criteria, Time_Off_Plan_Balance
 
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
 

Absence_Plan__All_Object

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

Absence_Plan__All_ObjectID

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

OrganizationObject

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

OrganizationObjectID

part of: OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Organization_Reference_ID, Region_Reference_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_Time_Off_Plan_Balances_Request, Get_Time_Off_Plan_Balances_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
 

Time_Off_Plan_Balance_Response_Group

part of: Get_Time_Off_Plan_Balances_Request, Get_Time_Off_Plan_Balances_Response
Time Off Plan Balance Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference ( 1 = True, 0 = False )   
Include_Time_Off_Plan_Balance_Data  boolean  [0..1]  Include Time Off Plan Balance Data ( 1 = True, 0 = False )   
top
 

Response_Results

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

Time_Off_Plan_Balance_Response_Data

part of: Get_Time_Off_Plan_Balances_Response
Time Off Plan Balance Response Data
 
Parameter name Type/Value Cardinality Description Validations
Time_Off_Plan_Balance  Time_Off_Plan_Balance  [0..*]  Time Off Plan Balance   
top
 

Time_Off_Plan_Balance

part of: Time_Off_Plan_Balance_Response_Data
Time Off Plan Balance
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  WorkerObject  [0..1]  Employee Reference   
Time_Off_Plan_Balance_Data  Time_Off_Plan_Balance_Data  [0..1]  Time Off Plan Balance Data   
top
 

Time_Off_Plan_Balance_Data

part of: Time_Off_Plan_Balance
Time Off Plan Balance Data
 
Parameter name Type/Value Cardinality Description Validations
Time_Off_Plan_Balance_Record  Time_Off_Plan_Balance_Record  [0..*]  Time Off Plan Balance Record   
top
 

Time_Off_Plan_Balance_Record

part of: Time_Off_Plan_Balance_Data
Time Off Plan Balance Record
 
Parameter name Type/Value Cardinality Description Validations
Time_Off_Plan_Reference  Absence_Plan__All_Object  [1..1]  Time Off Plan Reference   
Unit_of_Time_Reference  Unit_of_TimeObject  [1..1]  Unit of Time   
Time_Off_Plan_Balance_Position_Record  Time_Off_Plan_Balance_Position_Record  [1..*]  Time Off Plan Balance Position Record   
top
 

Unit_of_TimeObject

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

Unit_of_TimeObjectID

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

Time_Off_Plan_Balance_Position_Record

part of: Time_Off_Plan_Balance_Record
Time Off Plan Balance Position Record
 
Parameter name Type/Value Cardinality Description Validations
Position_Reference  PositionObject  [0..1]  Position Reference   
Time_Off_Plan_Balance  decimal (26, 6)   [1..1]  Time Off Plan Balance   
top
 

PositionObject

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

PositionObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Absence_Plan__All_ReferenceEnumeration

part of: Absence_Plan__All_ObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Unit_of_TimeReferenceEnumeration

part of: Unit_of_TimeObjectID
Base Type
string
top
 

PositionReferenceEnumeration

part of: PositionObjectID
Base Type
string
top