Service Directory > v32.1 > Academic_Foundation > Get_Extracurricular_Activities
 

Operation: Get_Extracurricular_Activities

Retrieves Extracurricular Activities by Name, Extracurricular Activity Category, or reference, or returns all Extracurricular Activities if no criteria is specified.


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

Container for Extracurricular Activity request subelements
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Extracurricular_Activity_Request_References  [0..1]  Container for Extracurricular Activity request references   
Request_Criteria [Choice]   Extracurricular_Activity_Request_Criteria  [0..1]  Container for Extracurricular Activity request criteria   
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_Extracurricular_Activities_Response

Get Extracurricular Activities Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Extracurricular_Activity_Request_References  [0..1]  Container for Extracurricular Activity request references   
Request_Criteria  Extracurricular_Activity_Request_Criteria  [0..1]  Container for Extracurricular Activity request criteria   
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  Extracurricular_Activity_Response_Data  [0..1]  Extracurricular Activity Response Data   
top
 

Extracurricular_Activity_Request_References

part of: Get_Extracurricular_Activities_Request, Get_Extracurricular_Activities_Response
Container for Extracurricular Activity request references
 
Parameter name Type/Value Cardinality Description Validations
Extracurricular_Activity_Reference  Extracurricular_ActivityObject  [1..*]  Work Set of Extracurricular Activities   
top
 

Extracurricular_ActivityObject

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

Extracurricular_ActivityObjectID

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

Extracurricular_Activity_Request_Criteria

part of: Get_Extracurricular_Activities_Request, Get_Extracurricular_Activities_Response
Container for Extracurricular Activity request criteria
 
Parameter name Type/Value Cardinality Description Validations
Extracurricular_Activity_Category_Reference  Extracurricular_Activity_CategoryObject  [0..*]  Container for Extracurricular Activity Categories used as request criteria   
top
 

Extracurricular_Activity_CategoryObject

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

Extracurricular_Activity_CategoryObjectID

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

Extracurricular_Activity_Response_Data

part of: Get_Extracurricular_Activities_Response
Extracurricular Activity Response Data
 
Parameter name Type/Value Cardinality Description Validations
Extracurricular_Activity  Extracurricular_Activity  [0..*]  Container for Extracurricular Activity instance and data   
top
 

Extracurricular_Activity

part of: Extracurricular_Activity_Response_Data
Container for Extracurricular Activity instance and data
 
Parameter name Type/Value Cardinality Description Validations
Extracurricular_Activity_Reference  Extracurricular_ActivityObject  [0..1]  The Instance of Extracurricular Activity   
Extracurricular_Activity_Data  Extracurricular_Activity_Data  [1..1]  The container for Extracurricular Activity data   
top
 

Extracurricular_Activity_Data

part of: Extracurricular_Activity
The container for Extracurricular Activity data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID attribute of the Extracurricular Activity   
Extracurricular_Activity_Name  string  [1..1]  The Name of the Extracurricular Activity 
Validation Description
Enter an Extracurricular Activity Name that isn't already in use.   
 
Academic_Unit_Shareable_Data  Has_Academic_Unit_with_Shareable_Subordinates_Data  [1..*]  Academic Unit and Level for Extracurricular Activity Data 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Extracurricular_Activity_Category_Reference  Extracurricular_Activity_CategoryObject  [0..*]  The Extracurricular Activity Category of the Extracurricular Activity   
top
 

Has_Academic_Unit_with_Shareable_Subordinates_Data

part of: Extracurricular_Activity_Data
Academic Unit Data with Shareable with Subordinates Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level for Has Academic Unit with Shareable Subordinates Data element   
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_Curricular_DivisionObject

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

Academic_Curricular_DivisionObjectID

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

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

Academic_LevelObjectID

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

Extracurricular_ActivityReferenceEnumeration

part of: Extracurricular_ActivityObjectID
Base Type
string
top
 

Extracurricular_Activity_CategoryReferenceEnumeration

part of: Extracurricular_Activity_CategoryObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top