Service Directory > v31.2 > Student_Records > Get_Student_Activity_Registration_Records
 

Operation: Get_Student_Activity_Registration_Records

Returns Student Activity Registration(s) by Reference ID, Student, or Activity Offering. Returns all Student Activity Registrations if no Reference ID or criteria 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_Activity_Registration_Records_Request

Get Student Activity Registration Records Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Activity_Registration_Record_Request_References  [0..1]  Element Container for Student Activity Registration Record Request References   
Request_Criteria [Choice]   Student_Activity_Registration_Record_Request_Criteria  [0..1]  Element Container for Student Activity Registration Record Request Criteria   
Response_Filter  Response_Filter  [0..1]  Element Container for Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Student_Activity_Registration_Records_Response

Get Student Activity Registration Records Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Activity_Registration_Record_Request_References  [0..1]  Element Container for Student Activity Registration Record Request Reference   
Request_Criteria  Student_Activity_Registration_Record_Request_Criteria  [0..1]  Element Container for Student Activity Registration Record Request Request   
Response_Filter  Response_Filter  [0..1]  Element Container for Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Element Container for Response Results   
Response_Data  Student_Activity_Registration_Record_Response_Data  [0..1]  Element Container for Student Activity Registration Record Response Data   
top
 

Student_Activity_Registration_Record_Request_References

part of: Get_Student_Activity_Registration_Records_Request, Get_Student_Activity_Registration_Records_Response
Student Activity Registration Record Request References
 
Parameter name Type/Value Cardinality Description Validations
Student_Activity_Registration_Record_Reference  Student_Activity_Registration_RecordObject  [1..*]  Element Container for Student Activity Registration Record   
top
 

Student_Activity_Registration_RecordObject

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

Student_Activity_Registration_RecordObjectID

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

part of: Get_Student_Activity_Registration_Records_Request, Get_Student_Activity_Registration_Records_Response
Student Activity Registration Record Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Student_Record_Reference  Academic_RecordObject  [0..1]  Element Container for Student Record   
Activity_Offering_Reference  Activity_OfferingObject  [0..1]  Element Container for Activity Offering   
top
 

Academic_RecordObject

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

Academic_RecordObjectID

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

Activity_OfferingObject

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

Activity_OfferingObjectID

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

Response_Filter

part of: Get_Student_Activity_Registration_Records_Request, Get_Student_Activity_Registration_Records_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_Activity_Registration_Records_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_Activity_Registration_Record_Response_Data

part of: Get_Student_Activity_Registration_Records_Response
Get Student Activity Registration Records Response
 
Parameter name Type/Value Cardinality Description Validations
Student_Activity_Registration_Record  Student_Activity_Registration_Record  [0..*]  Element Container for Student Activity Registration Record   
top
 

Student_Activity_Registration_Record

part of: Student_Activity_Registration_Record_Response_Data
Student Activity Registration Record Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Activity_Registration_Record_Reference  Student_Activity_Registration_RecordObject  [0..1]  Element Container for Student Activity Registration Record   
Student_Activity_Registration_Record_Data  Student_Activity_Registration_Record_Data  [0..*]  Element Container for Student Activity Registration Record Data 
Validation Description
A Student Activity Registration Record with this ID already exists and can't be edited.   
The Activity Offering is not open for registration. Please choose another Activity Offering.   
A registration for an Activity Offering without the Activity Behavior of Billable & Load Status cannot have a non-zero value for Student Registration Units.   
The Activity Offering must have the Activity Behavior of Enrollable & Eligible to be valid for registration.   
 
top
 

Student_Activity_Registration_Record_Data

part of: Student_Activity_Registration_Record
Student Activity Registration Record
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Element Container for ID   
Activity_Offering_Reference  Activity_OfferingObject  [1..1]  Element Container for Activity Offering   
Student_Record_Reference  Academic_RecordObject  [1..1]  Element Container for Student Record   
Units  decimal (8, 2) >0   [0..1]  Element Container for Student Registration Units   
Validation Description
A Student Activity Registration Record with this ID already exists and can't be edited.   
The Activity Offering is not open for registration. Please choose another Activity Offering.   
A registration for an Activity Offering without the Activity Behavior of Billable & Load Status cannot have a non-zero value for Student Registration Units.   
The Activity Offering must have the Activity Behavior of Enrollable & Eligible to be valid for registration.   
top
 

Student_Activity_Registration_RecordReferenceEnumeration

part of: Student_Activity_Registration_RecordObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Activity_OfferingReferenceEnumeration

part of: Activity_OfferingObjectID
Base Type
string
top