Service Directory > v32.1 > Academic_Foundation > Get_Educational_Institution_Course
 

Operation: Get_Educational_Institution_Course

Public Web Service Operation for Retrieving Educational Institution Courses


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

Web Service Element for requesting Educational Institution Courses
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Educational_Institution_Course_Request_References  [0..1]  Web Service Element for Educational Institution Course reference   
Request_Criteria [Choice]   Educational_Institution_Course_Request_Criteria  [0..1]  Web Service Element for specifying search criteria for Educational Institution Courses   
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_Course_Response

Web Service Element for the Educational Institution Course Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Educational_Institution_Course_Request_References  [0..*]  Web Service Element for Educational Institution Course reference   
Request_Criteria  Educational_Institution_Course_Request_Criteria  [0..*]  Web Service Element for specifying search criteria for Educational Institution Courses   
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  Educational_Institution_Course_Response_Data  [0..*]  Web Service Element for the Educational Institution Course Response Data   
top
 

Educational_Institution_Course_Request_References

part of: Get_Educational_Institution_Course_Request, Get_Educational_Institution_Course_Response
Web Service Element for Educational Institution Course reference
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Course_Reference  Educational_Institution_CourseObject  [1..*]  Specifies the Educational Institution Course to be returned   
top
 

Educational_Institution_CourseObject

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

Educational_Institution_CourseObjectID

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

part of: Get_Educational_Institution_Course_Request, Get_Educational_Institution_Course_Response
Web Service Element for specifying search criteria for Educational Institution Courses
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Reference  Educational_InstitutionObject  [0..1]  Specifies the Educational Institution for which the Educational Institution Course is for.   
top
 

Educational_InstitutionObject

part of: Educational_Institution_Course_Data, Educational_Institution_Course_Request_Criteria
 
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
 

Response_Filter

part of: Get_Educational_Institution_Course_Request, Get_Educational_Institution_Course_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_Course_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_Course_Response_Data

part of: Get_Educational_Institution_Course_Response
Web Service Element for the Educational Institution Course Response Data
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Course  Educational_Institution_Course  [0..*]  Web Service Element for Educational Institution Course   
top
 

Educational_Institution_Course

part of: Educational_Institution_Course_Response_Data
Web Service Element for Educational Institution Course
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Course_Reference  Educational_Institution_CourseObject  [1..1]  Reference ID for the Educational Institution Course   
Educational_Institution_Course_Data  Educational_Institution_Course_Data  [1..1]  The Web Service Element holding Educational Institution Course Data 
Validation Description
Course ID and Course Title combination must be unique.   
 
top
 

Educational_Institution_Course_Data

part of: Educational_Institution_Course
The Web Service Element holding Educational Institution Course Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Educational Institution Course   
Educational_Institution_Reference  Educational_InstitutionObject  [1..1]  References the Educational Institution   
Educational_Institution_Course_Number  string  [1..1]  Specifies the Course Number for the Educational Institution Course   
Educational_Institution_Course_Academic_Area_Reference  Educational_Institution_Course_Academic_AreaObject  [0..1]  References the Academic Area of the Educational Institution Course   
Educational_Institution_Course_Title  string  [1..1]  Specifies the Title of the Educational Institution Course   
Educational_Institution_Course_Designations_Reference  Educational_Institution_Course_DesignationObject  [0..*]  References the Course Designation for the Educational Institution Course   
Educational_Institution_Course_Credits  decimal (8, 2) >0   [0..1]  Specifies the Credits for the Educational Institution Course   
Educational_Institution_Course_Unit_Type_Reference  Other_Unit_TypeObject  [0..1]  References the Course Unit Type   
Educational_Institution_Course_Description  string  [0..1]  Specifies the Description for the Educational Institution Course   
Educational_Institution_Course_Notes  string  [0..1]  Specifies the Notes for the Educational Institution Course   
Validation Description
Course ID and Course Title combination must be unique.   
top
 

Educational_Institution_Course_Academic_AreaObject

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

Educational_Institution_Course_Academic_AreaObjectID

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

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

Educational_Institution_Course_DesignationObjectID

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

Other_Unit_TypeObject

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

Other_Unit_TypeObjectID

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

part of: Educational_Institution_CourseObjectID
Base Type
string
top
 

Educational_InstitutionReferenceEnumeration

part of: Educational_InstitutionObjectID
Base Type
string
top
 

Educational_Institution_Course_Academic_AreaReferenceEnumeration

part of: Educational_Institution_Course_Academic_AreaObjectID
Base Type
string
top
 

Educational_Institution_Course_DesignationReferenceEnumeration

part of: Educational_Institution_Course_DesignationObjectID
Base Type
string
top
 

Other_Unit_TypeReferenceEnumeration

part of: Other_Unit_TypeObjectID
Base Type
string
top