Service Directory > v32.1 > Academic_Foundation

 

Web Service: Academic_Foundation (v32.1)

Public Web Service for creating, editing and retrieving the foundational objects for the Student System, such as Programs of Study, Educational Institutions, and other other objects with cross-module uses.

Version

Operations

Operation Description
Change_Institutional_Contact_Information Creates or updates institutional contact information for a person. Contact information includes email addresses, physical addresses, and phone numbers. Changes are routed through existing Institutional Contact Change business process for necessary approvals. 
Get_Academic_Contacts Returns the Name, Job Title, and contact information of an Academic Contact (or Representative) by reference, or returns all Academic Contacts (also known as Representatives) if no reference is specified. 
Get_Accommodations_for_Student Returns the Accommodation, Disability and supporting document information for a Student's approved Student Accommodation request using the Student and Institutional Academic Unit request Criteria, or returns Accommodation information for all Students if no criteria is specified. This task does not support request references; request criteria should be used to identify the specific Students and Academic Units for which Accommodation information should be returned. 
Get_Education_Test_Results Returns Education Test Result based on Student, Date Taken and Test Type, or returns all instances of Education Test Result if no criteria is specified. 
Get_Educational_Institution_Attendances Returns Educational Institution Attendances by Reference ID, or returns all Educational Institution Attendances if no Reference ID is provided. 
Get_Educational_Institution_Course Public Web Service Operation for Retrieving Educational Institution Courses 
Get_Educational_Institution_Grading_Schemes Returns Educational Institution Grading Scheme by Reference ID, or returns all External Institution Grading Schemes if no Reference ID is provided. 
Get_Educational_Taxonomy_Schemes Retrieves Educational Taxonomy Schemes by reference, or returns all Educational Taxonomy Schemes if no criteria is specified. 
Get_External_Associations Retrieves External Association records by the External Association Name or reference, or returns all External Associations if no reference is specified. 
Get_Extracurricular_Activities Retrieves Extracurricular Activities by Name, Extracurricular Activity Category, or reference, or returns all Extracurricular Activities if no criteria is specified. 
Get_Maintained_Academic_Periods Retrieves Academic Periods by Reference ID, or returns all Academic Periods if no Reference IDs are specified. 
Get_Primary_Disability_for_Students Returns the Primary Disability for a Student using the Student and Institutional Academic Unit request Criteria, or returns Primary Disabilities for all Students if no criteria is specified. This task does not support request references; request criteria should be used to identify the specific Students and Academic Units for which Primary Disability should be returned. 
Get_Program_of_Study_Exploration_Details Returns information for Program of Study Exploration Details Data specified in the request. If the request does not specify a Program of Study Exploration Details Data, this operation returns information for all Program of Study Exploration Details Data. 
Get_Programs_of_Study Returns Programs of Study based on Code and Effective Date, or returns all instances of Programs of Study if no criteria is specified. Only values that are effective as of the specified Effective Date will be returned. 
Get_Prospective_Students Web service task for retrieving all information attached to a Student Prospect. The Response Groups and Request Criteria elements can be used to isolate the specific information that should be returned. 
Get_Student_Cohort_Memberships Get Student Cohort Membership information for a Student Cohort. 
Get_Student_Educational_Institution Retrieves Educational Institution records by Educational Institution Name or by reference, or returns all Educational Institutions if no criteria is specified. Will replace Educational Institution Web Service as of w25 
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 
Get_Student_Friends_and_Family Public Web Service for retrieving Student Proxies 
Get_Student_Grading_Schemes Returns Student Grading Scheme based on Name and Effective Date, or returns all instances of Student Grading Scheme if no criteria is specified. Only values that are effective as of the specified Effective Date will be returned. 
Get_Student_Hold_Assignments Web Service to Get Student Hold Assignments and information relating to the Holds. 
Get_Student_Hold_Reasons This web service will retrieve data about a Student Hold Reason, including its name, description, resolution instructions, and which hold types it applies to. 
Get_Student_Housing_Assignments This Web Service Task is for: 1. Getting particular Student Housing Assignments 2. Getting all Student Housing Assignments 3. Getting all Student Housing Assignments for a Student 
Get_Student_Immigration_Data Returns Student Immigration Datas by Reference ID, or returns all Student Immigration Datas if no Reference ID is provided. Returns Student Immigration Data by Reference ID. Returns all Student Immigration Data if no Reference ID or criteria is provided. 
Get_Student_Note_Topics Retrieves Student Note Topics 
Get_Student_Period_Record_Overrides Get Student Period Record instances via Reference ID 
Get_Student_Residencies This web service operation returns effective-dated Student residency information and the Student Documents that support the residency information. The Student, Institutional Academic Unit and Effective Date request criteria can be used to identify a specific subset of Students who have had their residency statuses determined. If the Effective Date request criteria is not used, only currently effective residency data will be returned. This operation does not support Request References. The Response Groups element can be used to include or exclude the Student Document Attachment data from the response. 
Get_Student_Tag_Categories Returns Student Tag Categories by Reference ID, or returns all Student Tag Categories if no Reference IDs are specified. 
Get_Student_Tags Returns Student Tags by Reference ID, or returns all Student Tags if no Reference IDs are specified. 
Get_Student_Veterans_Benefits Returns Student Veterans Benefits by Reference ID, or returns all Student Veterans Benefits if no Reference ID is provided. 
Get_Students Web service task for retrieving all information attached to a Student with a Student Record. Custom Field data that is attached to Students can also be retrieved via this task. Request References can be used along with Request Criteria in this task. If both are supplied in a request, only the referenced Students that match all Criteria will be returned. 
Get_Universal_Identifier Request for Universal Identifiers. Use a Person Reference to get the Universal ID for the Person or don't request anybody and get all Universal IDs. 
Import_Education_Test_Results Imports Education Test Results. Matching logic is used in processing to try to associate each Test Result with an existing Student in the system; if no Student is found, a new Student will be created with a new Test Result. The post-processing of this web service task expects that all Education Test Results created via a single Import request will be for a single Academic Unit. 
Import_Educational_Institution_Attendances This process uses a Put-type web service operation to load a large number of Educational Institution Attendances. However, instead of loading all Educational Institution Attendances in a single transaction, the Import Web Service Process splits up the request into smaller chunks that are processed in separate XpressO Jobs. 
Import_Student_Hold_Assignments Web Service to Bulk Load Hold Assignments for Students by supplying a Hold Reason and Hold Type. 
Import_Student_Housing_Assignments The Web Service Background Process used to Import Student Housing Assignments. Can either specify an ID of an existing Student Housing Assignment to edit it, or create a new Student Housing Assignment if the ID currently doesn't exist. 
Import_Student_IDs Import Student IDs is an edit-only, high-volume web service task that enables you to edit multiple Student IDs at once. 
Import_Student_Period_Record_Overrides This task can edit existing Student Period Records by the Student Period Record reference ID, or by supplying a student and an academic period. It will use the student's active student record and pick the Student Period Record based on academic period. 
Import_Student_Personal_Information This operation is intended for use during implementation only. This high-volume web service task creates Students with biographic and demographic data only (Name, Contact Information, Personal Profile, IDs, etc.) 
Import_Universal_Identifiers Import Universal Identifiers. It's required to put a Person Reference. Either place a manual Universal ID or no Universal ID, if no Universal ID is supplied it will use the Universal ID generator. 
Put_Academic_Contact Creates a new Academic Contact, which is also referred to as a Representative (or edits an existing Academic Contact/Representative) with a Name, Job Title, and contact information. The Academic Contact (or Representative) can also be assigned to an Educational Institution or External Association using this operation. 
Put_Education_Test_Result Creates a new Education Test Result (or updates an existing Education Test Result) with the information supplied in the request. 
Put_Educational_Institution_Attendance This web service creates a new Educational Institution Attendance (or updates an existing Educational Institution Attendance) with the information supplied in the request. 
Put_Educational_Institution_Course Public Web Service Operation for Adding/Editing Educational Institution Courses 
Put_Educational_Institution_Grading_Scheme Creates a new Educational Institution Grading Scheme (or updates an existing Educational Institutional Grading Scheme) with the information supplied in the request. 
Put_Educational_Taxonomy_Scheme Creates a new Educational Taxonomy Scheme (or updates an existing Educational Taxonomy Scheme) with the information supplied in the request. 
Put_External_Association Creates a new External Association (or updates an existing External Association) with the information supplied in the request. 
Put_Extracurricular_Activity Creates an Extracurricular Activity (or updates an existing Extracurricular Activity) with the information provided in the request. 
Put_Maintained_Academic_Period Creates a new Academic Period (or updates an existing Academic Period) with the information supplied in the request. 
Put_Primary_Disability_for_Student Changes primary student disability for a student on a per-institutional academic unit basis using the information provided in the request. 
Put_Program_of_Study Creates a new Programs of Study (or updates an existing Program of Study) with the information supplied in the request. If a reference ID is provided with a new Effective Date, a new Program of Study snapshot will be created with the effective dated fields. 
Put_Student_Cohort_Membership Put Student Cohort Membership information for a Student Cohort. 
Put_Student_Educational_Institution Creates a new Educational Institution (or updates an existing Educational Institution) with the information supplied in the request. 
Put_Student_Educational_Institution_District Adds a new Educational Institution District (or updates an existing Educational Institution District) with the information supplied in the request. Valid for >=w25 
Put_Student_Friends_and_Family Public Web Service for adding or editing Student Proxies 
Put_Student_Grading_Scheme Creates a new Student Grading Scheme(or updates an existing Student Grading Scheme) with the information supplied in the request. If a reference ID is provided with a new Effective Date, a new Program of Study snapshot will be created with the effective dated fields. 
Put_Student_Hold_Assignment Web Service to Put a Student Hold Assignment on a Student. 
Put_Student_Hold_Reason This web service task will create or update Student Hold Reasons 
Put_Student_ID Updates the existing Student ID of the referenced Student to the Student ID supplied in the request. 
Put_Student_Immigration_Data Creates a new Student Immigration Data for a given Student (or updates an existing Student Immigration Data) with the information supplied in the request. 
Put_Student_Note_Topic Adds or updates a Student Note Topic using the information provided in the request. 
Put_Student_Tag Adds a new Student Tag (or updates an existing Student Tag) with the information supplied in the request. 
Put_Student_Tag_Category Adds a new Student Tag Category (or updates an existing Student Tag Category) with the information supplied in the request. 
Put_Student_Veteran_Benefits Creates a new Student Veteran Benefits (or updates an existing Student Veteran Benefits) with the information supplied in the request. 
Put_Universal_Identifier Put Request for Universal Identifiers. It's required to put a Person Reference in either Person Reference. Either place a manual Universal ID or no Universal ID, if no Universal ID is supplied it will use the Universal ID generator. 
Submit_Accommodation_for_Student Creates new Accommodation and Disability data for a Student on a per-Institutional Academic Unit basis using the information provided in the request. This task cannot be used to edit existing Accommodation and Disability information for a Student. This task initiates and automatically completes the Student Accommodation Event Business Process. 
Submit_Program_of_Study_Exploration_Details Creates Program of Study Exploration Details for a Program of Study or updates existing details 
Submit_Student_Residency This web service operation will create or update effective-dated residency information for a Student. This task also allows Student Documents for residency determination to be created or edited.