Service Directory > v32.1 > Academic_Foundation > Get_Educational_Institution_Attendances
 

Operation: Get_Educational_Institution_Attendances

Returns Educational Institution Attendances by Reference ID, or returns all Educational Institution Attendances 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_Educational_Institution_Attendances_Request

Wrapper element for the Get Educational Institution Attendances Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Educational_Institution_Attendance_Request_References  [0..1]  Element containing the list of Educational Institution Attendances for which data is requested.   
Request_Criteria [Choice]   Educational_Institution_Attendance_Request_Criteria  [0..1]  Utilize the following criteria options to search for Educational Institution Attendances within the Workday system. The Educational Institution Attendance 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..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_Educational_Institution_Attendances_Response

Wrapper element for the Educational Institution Attendance Information returned as a result of a Get Educational Institution Attendances.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Educational_Institution_Attendance_Request_References  [0..1]  Element containing the list of Educational Institution Attendances for which data is requested.   
Request_Criteria  Educational_Institution_Attendance_Request_Criteria  [0..1]  Utilize the following criteria options to search for Educational Institution Attendances within the Workday system. The Educational Institution Attendance 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..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  Educational_Institution_Attendance_Response_Data  [0..1]  Wrapper Element for the Educational Institution Attendances data.   
top
 

Educational_Institution_Attendance_Request_References

part of: Get_Educational_Institution_Attendances_Request, Get_Educational_Institution_Attendances_Response
Element containing the list of Educational Institution Attendances for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Attendance_Reference  Educational_Institution_AttendanceObject  [1..*]  The Educational Institutional Attendance class for the Get Educational Institutional Attendances WS   
top
 

Educational_Institution_AttendanceObject

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

Educational_Institution_AttendanceObjectID

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

Educational_Institution_Attendance_Request_Criteria

part of: Get_Educational_Institution_Attendances_Request, Get_Educational_Institution_Attendances_Response
Utilize the following criteria options to search for Educational Institution Attendances within the Workday system. The Educational Institution Attendance 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
top
 

Response_Filter

part of: Get_Educational_Institution_Attendances_Request, Get_Educational_Institution_Attendances_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_Educational_Institution_Attendances_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
 

Educational_Institution_Attendance_Response_Data

part of: Get_Educational_Institution_Attendances_Response
Wrapper Element for the Educational Institution Attendance Data
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Attendance  Educational_Institution_Attendance  [0..*]  The Educational Institution Attendance Element for the Get Educational Institution Attendances WS   
top
 

Educational_Institution_Attendance

part of: Educational_Institution_Attendance_Response_Data
Educational Institution Attendance element
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Attendance_Reference  Educational_Institution_AttendanceObject  [0..1]  The Educational Institutional Attendance class for the Get Educational Institutional Attendances WS   
Educational_Institution_Attendance_Data  Student_Educational_Institution_Attendance_Data  [0..*]  Wrapper element for the Student Educational Institutional Attendance Data   
top
 

Student_Educational_Institution_Attendance_Data

part of: Educational_Institution_Attendance
Wrapper element for the Student Educational Institutional Attendance Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID Attribute for the Educational Institution Attendance WS   
Student_Reference  StudentObject  [1..1]  Student for Educational Institution Attendance   
Educational_Institution_Reference  Educational_InstitutionObject  [1..1]  Education Institution for Educational Institution Attendance   
Start_Date  date  [0..1]  The Start Date for the Educational Institution Attendance WS   
Exit_Date  date  [0..1]  The Exit Date for the Educational Institution Attendance WS   
top
 

StudentObject

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

Educational_InstitutionObject

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

Educational_InstitutionObjectID

part of: Educational_InstitutionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Educational_Institution_CCD_ID, Educational_Institution_ID, Educational_Institution_Postsecondary_CEEB_ATP_ID, Educational_Institution_Postsecondary_Federal_ID, Educational_Institution_Postsecondary_IPEDS_ID, Educational_Institution_Postsecondary_Local_ID, Educational_Institution_Postsecondary_OPEID_ID, Educational_Institution_Postsecondary_Other_ID, Educational_Institution_Postsecondary_State_ID, Educational_Institution_Secondary_CEEB_ATP_ID, Educational_Institution_Secondary_Local_ID, Educational_Institution_Secondary_NCES_ID, Educational_Institution_Secondary_Other_ID, Educational_Institution_Secondary_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
 

Educational_Institution_AttendanceReferenceEnumeration

part of: Educational_Institution_AttendanceObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Educational_InstitutionReferenceEnumeration

part of: Educational_InstitutionObjectID
Base Type
string
top