Service Directory > v32.1 > Student_Records > Get_Student_Program_of_Study_Record_Status_Reasons
 

Operation: Get_Student_Program_of_Study_Record_Status_Reasons

Returns Student Program of Study Record Status Reasons by Reference ID, or returns all Student Program of Study Record Status Reasons if no Reference ID is provided.


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

Element Container for Student Program of Study Record Status Reason Request References [EL],Student Program of Study Record Status Reason Request Criteria [EL],Response Filter [EL]
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Program_of_Study_Record_Status_Reason_Request_References  [0..1]  Request References for Student Program of Study Record Status Reason   
Request_Criteria [Choice]   Student_Program_of_Study_Record_Status_Reason_Request_Criteria  [0..1]  Request Criteria for Student Program of Study Record Status Reason   
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_Student_Program_of_Study_Record_Status_Reasons_Response

Element Container for Student Program of Study Record Status Reason Request References [EL],Student Program of Study Record Status Reason Request Criteria [EL], Response Filter [EL], Response Results [EL],Student Program of Study Record Status Reason Response Data [EL]
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Program_of_Study_Record_Status_Reason_Request_References  [0..1]  Element Container for Student Program of Study Record Status Reason [Nonsingular]   
Request_Criteria  Student_Program_of_Study_Record_Status_Reason_Request_Criteria  [0..1]  Request Criteria for Student Program of Study Record Status Reason   
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  Student_Program_of_Study_Record_Status_Reason_Response_Data  [0..1]  Student Program of Study Record Status Reason Response Data   
top
 

Student_Program_of_Study_Record_Status_Reason_Request_References

part of: Get_Student_Program_of_Study_Record_Status_Reasons_Response, Get_Student_Program_of_Study_Record_Status_Reasons_Request
Element Container for Student Program of Study Record Status Reason [Nonsingular]
 
Parameter name Type/Value Cardinality Description Validations
Student_Program_of_Study_Record_Status_Reason_Reference  Student_Program_of_Study_Record_Status_ReasonObject  [1..*]  Student Program of Study Record Status Reason Reference   
top
 

Student_Program_of_Study_Record_Status_ReasonObject

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

Student_Program_of_Study_Record_Status_ReasonObjectID

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

Student_Program_of_Study_Record_Status_Reason_Request_Criteria

part of: Get_Student_Program_of_Study_Record_Status_Reasons_Response, Get_Student_Program_of_Study_Record_Status_Reasons_Request
Request Criteria for Student Program of Study Record Status Reason
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Program_of_Study_Record_Status_Reasons_Response, Get_Student_Program_of_Study_Record_Status_Reasons_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_Student_Program_of_Study_Record_Status_Reasons_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
 

Student_Program_of_Study_Record_Status_Reason_Response_Data

part of: Get_Student_Program_of_Study_Record_Status_Reasons_Response
Element container for Student Program of Study Record Status Reason [EL]
 
Parameter name Type/Value Cardinality Description Validations
Student_Program_of_Study_Record_Status_Reason  Student_Program_of_Study_Record_Status_Reason  [0..*]  Student Program of Study Record Status Reason   
top
 

Student_Program_of_Study_Record_Status_Reason

part of: Student_Program_of_Study_Record_Status_Reason_Response_Data
Element Container for Student Program of Study Record Status Reason [Singular] [WS], Student Program of Study Record Status Reason Data [EL]
 
Parameter name Type/Value Cardinality Description Validations
Student_Program_of_Study_Record_Status_Reason_Reference  Student_Program_of_Study_Record_Status_ReasonObject  [0..1]  Student Program of Study Record Status Reason Reference   
Student_Program_of_Study_Record_Status_Reason_Data  Student_Program_of_Study_Record_Status_Reason_Data  [0..*]  Student Program of Study Record Status Reason Data 
Validation Description
Student Program of Study Record Status Reason must have a unique name.   
 
top
 

Student_Program_of_Study_Record_Status_Reason_Data

part of: Student_Program_of_Study_Record_Status_Reason
Student Program of Study Record Status Reason Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Student Program of Study Record Status Reason   
Status_Reason_Name  string  [1..1]  Name for Program of Study Record Status Reason   
Validation Description
Student Program of Study Record Status Reason must have a unique name.   
top
 

Student_Program_of_Study_Record_Status_ReasonReferenceEnumeration

part of: Student_Program_of_Study_Record_Status_ReasonObjectID
Base Type
string
top