Service Directory > v31.2 > Academic_Foundation > Get_Student_Period_Record_Overrides
 

Operation: Get_Student_Period_Record_Overrides

Get Student Period Record instances via Reference ID


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

Wrapper element for Student Period Record Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Period_Record_Overrides_Request_References  [0..1]  Element containing the list of Student Period Records for which data is requested.   
Request_Criteria [Choice]   Student_Period_Record_Overrides_Request_Criteria  [0..1]  Utilize the following criteria options to search for Student Period Records within the Workday system.   
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_Period_Record_Overrides_Response

Wrapper element for the Student Period Record information returned as a result of a Get Student Period Record Request EC
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Period_Record_Overrides_Request_References  [0..1]  Element containing the list of Student Period Records for which data is requested.   
Request_Criteria  Student_Period_Record_Overrides_Request_Criteria  [0..1]  Utilize the following criteria options to search for Student Period Records within the Workday system.   
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_Period_Record_Overrides_Response_Data  [0..1]  Wrapper Element for the Student Period Records data   
top
 

Student_Period_Record_Overrides_Request_References

part of: Get_Student_Period_Record_Overrides_Request, Get_Student_Period_Record_Overrides_Response
Element containing the list of Student Period Records for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Student_Period_Record_Reference  Financial_Aid_Period_RecordObject  [1..*]  List of Student Period Records for which data is requested.   
top
 

Financial_Aid_Period_RecordObject

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

Financial_Aid_Period_RecordObjectID

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

part of: Get_Student_Period_Record_Overrides_Request, Get_Student_Period_Record_Overrides_Response
Utilize the following criteria options to search for Anticipated Payment Display Rules within the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Period_Record_Overrides_Request, Get_Student_Period_Record_Overrides_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_Student_Period_Record_Overrides_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_Period_Record_Overrides_Response_Data

part of: Get_Student_Period_Record_Overrides_Response
Wrapper Element for the Student Period Record data
 
Parameter name Type/Value Cardinality Description Validations
Student_Period_Record  Student_Period_Record_Overrides  [0..*]  Wrapper element for the Student Period Record Data   
top
 

Student_Period_Record_Overrides

part of: Student_Period_Record_Overrides_Response_Data
Wrapper element for Student Period Record Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Period_Record_Reference  Financial_Aid_Period_RecordObject  [0..1]  Student Period Record Reference   
Student_Period_Record_Data  Student_Period_Record_Overrides_Data  [0..*]  Wrapper element for Student Period Record Data 
Validation Description
The supplied Student Period Record does not match the Student and Academic Period or does not exist.   
Submit either Student Reference or Financial Aid Record Reference.   
Student has more than one Financial Aid Record. Please provide a reference to the Financial Aid Record.   
Entered Student must be matriculated.   
 
top
 

Student_Period_Record_Overrides_Data

part of: Student_Period_Record_Overrides
Wrapper element for Student Period Record Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Student Period Record   
Student_Reference  StudentObject  [0..1]  Student Record for which the Student Period Record belongs   
Financial_Aid_Record_Reference  Financial_Aid_RecordObject  [0..1]  Financial Aid Record for which the Financial Aid Period Record belongs   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Academic Period for which the Student Period Record belongs   
Satisfactory_Academic_Progress_Status_Reference  Satisfactory_Academic_Progress_StatusObject  [1..1]  Satisfactory Academic Progress Status for Student Period Record   
On_Academic_Plan  boolean  [0..1]  Is SAP status on Financial Aid Academic Plan   
Number_of_Appeals_Granted  decimal (3, 0) >0   [0..1]  Number of appeals granted   
Validation Description
The supplied Student Period Record does not match the Student and Academic Period or does not exist.   
Submit either Student Reference or Financial Aid Record Reference.   
Student has more than one Financial Aid Record. Please provide a reference to the Financial Aid Record.   
Entered Student must be matriculated.   
top
 

StudentObject

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

StudentObjectID

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

Financial_Aid_RecordObject

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

Financial_Aid_RecordObjectID

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

Academic_PeriodObject

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

Academic_PeriodObjectID

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

Satisfactory_Academic_Progress_StatusObject

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

Satisfactory_Academic_Progress_StatusObjectID

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

Financial_Aid_Period_RecordReferenceEnumeration

part of: Financial_Aid_Period_RecordObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Financial_Aid_RecordReferenceEnumeration

part of: Financial_Aid_RecordObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Satisfactory_Academic_Progress_StatusReferenceEnumeration

part of: Satisfactory_Academic_Progress_StatusObjectID
Base Type
string
top