Service Directory > v31.2 > Academic_Foundation > Get_Program_of_Study_Exploration_Details
 

Operation: Get_Program_of_Study_Exploration_Details

Returns information for Program of Study Exploration Details Data specified in the request. If the request does not specify a Program of Study Exploration Details Data, this operation returns information for all Program of Study Exploration Details Data.


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

Get Program of Study Exploration Details Data Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Program_of_Study_Exploration_Details_Request_References  [0..1]  Request Reference for Program of Study Exploration Details 
Validation Description
This Program of Study does not have any Program of Study Exploration Details.   
 
Request_Criteria  Program_of_Study_Exploration_Details_Request_Criteria  [0..1]  Element to specify criteria options to search for Program of Study Exploration Details Data within the Workday system. Search by Program of Study   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Program_of_Study_Exploration_Details_Response

Response to Get Program of Study Exploration Details Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Program_of_Study_Exploration_Details_Request_Criteria  [0..1]  Request Criteria for the Get Program of Study Exploration Details Data Web Service   
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  Program_of_Study_Exploration_Details_Response_Data  [0..1]  Response Data for Get Program of Study Exploration Details Data   
top
 

Program_of_Study_Exploration_Details_Request_References

part of: Get_Program_of_Study_Exploration_Details_Request
Request Reference for Program of Study Exploration Details
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Reference  Program_of_StudyObject  [0..*]  Programs of Study whose Exploration Details Data will be returned in the Get Program of Study Exploration Details Data Web Service   
Validation Description
This Program of Study does not have any Program of Study Exploration Details.   
top
 

Program_of_StudyObject

part of: Program_of_Study_Exploration_Details_Request_References, Program_of_Study_Exploration_Details, Program_of_Study_Exploration_Details_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  Program_of_StudyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Program_of_StudyObjectID

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

Program_of_Study_Exploration_Details_Request_Criteria

part of: Get_Program_of_Study_Exploration_Details_Request, Get_Program_of_Study_Exploration_Details_Response
Request Criteria for the Get Program of Study Exploration Details Data Web Service
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Program_of_Study_Exploration_Details_Request, Get_Program_of_Study_Exploration_Details_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
 

Response_Results

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

Program_of_Study_Exploration_Details_Response_Data

part of: Get_Program_of_Study_Exploration_Details_Response
Response for Get Program of Study Exploration Details Data
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Exploration_Details  Program_of_Study_Exploration_Details  [0..*]  Response Data for Program of Study Exploration Details Data   
top
 

Program_of_Study_Exploration_Details

part of: Program_of_Study_Exploration_Details_Response_Data
Response Data for Program of Exploration Details Data
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Reference  Program_of_StudyObject  [0..1]  Program of Study Exploration Details Data Reference for Program of Study Exploration Details Data Web Service   
Program_of_Study_Exploration_Details_Data  Program_of_Study_Exploration_Details_Data  [0..*]  Program of Study Exploration Details Data Element for Program of Study Exploration Details Data Web Service   
top
 

Program_of_Study_Exploration_Details_Data

part of: Program_of_Study_Exploration_Details
Data Element for Put Program of Study Exploration Details Data Request
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Reference  Program_of_StudyObject  [1..1]  Program of Study for Program of Study Exploration Details Data   
Overview  string  [0..1]  Overview for Program of Study Exploration Details Data   
Description  string  [0..1]  Description for Program of Study Exploration Details Data   
URL  string  [0..1]  URL for Program of Study Exploration Details Data   
Worker_Reference  WorkerObject  [0..1]  Worker for Program of Study Exploration Details Data   
top
 

WorkerObject

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

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top