Service Directory > v31.2 > Academic_Foundation > Get_Student_Educational_Institution_Districts
 

Operation: Get_Student_Educational_Institution_Districts

Returns Educational Institution Districts based on Educational Institution District Names, or returns all Educational Institution Districts if no criteria is specified. This Web Service should be used as of w25


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

Wrapper element for Educational Institution Districts Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Educational_Institution_District_Request_References  [0..1]  Element containing the list of Educational Institution District(s) for which data is requested.   
Request_Criteria [Choice]   Student_Educational_Institution_District_Request_Criteria  [0..1]  Criteria specified to select Educational Institution Districts   
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_Educational_Institution_Districts_Response

Documentation The wrapper element for Educational Institution District Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Educational_Institution_District_Request_References  [0..*]  Element containing the list of Educational Institution Districts for which data is requested.   
Request_Criteria  Student_Educational_Institution_District_Request_Criteria  [0..*]  Utilize the following criteria options to search for Educational Institutions within the Workday system. The Educational Institution references that are returned are those that satisfy ALL criteria included in the request. Therefore, the result set will become more limited with every criterium that is populated.   
Response_Filter  Response_Filter  [0..*]  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..*]  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_Educational_Institution_District_Response_Data  [0..*]  Wrapper element for Educational Institution District Response data   
top
 

Student_Educational_Institution_District_Request_References

part of: Get_Student_Educational_Institution_Districts_Response, Get_Student_Educational_Institution_Districts_Request
Element containing the list of Educational Institutions for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_District_Reference  Educational_Institution_DistrictObject  [1..*]  Educational Institution Reference   
top
 

Educational_Institution_DistrictObject

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

Educational_Institution_DistrictObjectID

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

part of: Get_Student_Educational_Institution_Districts_Response, Get_Student_Educational_Institution_Districts_Request
Utilize the following criteria options to search for Educational Institution Districts within the Workday system. The Educational Institution references that are returned are those that satisfy ALL criteria included in the request. Therefore, the result set will become more limited with every criterium that is populated.
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_District_Name  string  [0..1]  Search for an Educational Institution District using the Name.   
top
 

Response_Filter

part of: Get_Student_Educational_Institution_Districts_Response, Get_Student_Educational_Institution_Districts_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_Educational_Institution_Districts_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_Educational_Institution_District_Response_Data

part of: Get_Student_Educational_Institution_Districts_Response
Wrapper element for Educational Institution District Response data
 
Parameter name Type/Value Cardinality Description Validations
Student_Educational_Institution_District  Student_Educational_Institution_District  [0..*]  Wrapper element for the Educational Institution District data.   
top
 

Student_Educational_Institution_District

part of: Student_Educational_Institution_District_Response_Data
Wrapper element for Educational Institution District Data
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_District_Reference  Educational_Institution_DistrictObject  [0..1]  Educational Institution District Reference   
Student_Educational_Institution_District_Data  Student_Educational_Institution_District_Data  [0..*]  Wrapper element for Educational Institution District Data   
top
 

Student_Educational_Institution_District_Data

part of: Student_Educational_Institution_District
Student Educational Institution District Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Educational Institution District Reference ID   
Educational_Institution_District_Name  string  [1..1]  Educational Institution District Name   
Educational_Institution_District_NCES_ID  string  [0..1]  Educational Institution District NCES ID   
Educational_Institution_District_State_ID  string  [0..1]  Educational Institution District State ID   
top
 

Educational_Institution_DistrictReferenceEnumeration

part of: Educational_Institution_DistrictObjectID
Base Type
string
top