Service Directory > v23.0 > Academic_Foundation

 

Web Service: Academic_Foundation (v23.0)

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
Get_Academic_Contacts Returns the Name, Job Title, and contact information of an Academic Contact by reference, or returns all Academic Contacts if no reference is specified. 
Get_Educational_Institution_Districts DEPRECATED Returns Educational Institution Districts based on Educational Institution District Names, or returns all Educational Institution Districts if no criteria is specified. 
Get_Educational_Institutions Retrieves Educational Institution records by Educational Institution Name or by reference, or returns all Educational Institutions 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_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_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. 
Put_Academic_Contact Creates a new Academic Contact (or edits an existing Academic Contact) with a Name, Job Title, and contact information. The Academic Contact can also be assigned to an Educational Institution or External Association using this operation. 
Put_Educational_Institution Creates a new Educational Institution (or updates an existing Educational Institution) with the information supplied in the request. 
Put_Educational_Institution_District DEPRECATED Adds a new Educational Institution District (or updates an existing Educational Institution District) 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_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_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.