ASP.NET Web API Help Page - SchoolMint Aeries API

Introduction

Provide a general description of your APIs here.

MiiApi

Handles API requests for the MII table.

API	Description
GET api/v2/mii/{studentId}	Get information using the Student ID.
GET api/v2/mii/{schoolCode}/{studentNumber}	Get information using School Code and Student Number.
PUT api/v2/mii	Update a record.
POST api/v2/mii	Create a new record.
DELETE api/v2/mii	Deletes a record.
DELETE api/v2/mii/deleteall	Deletes all records.
POST api/v2/mii/replace	Replaces all records.

MlmApi

Handles API requests for the MLM table.

API	Description
GET api/v2/mlm/{studentId}	Get information using the Student ID.
GET api/v2/mlm/{schoolCode}/{studentNumber}	Get information using School Code and Student Number.
PUT api/v2/mlm	Update a record.
POST api/v2/mlm	Create a new record.
DELETE api/v2/mlm	Deletes a record.
DELETE api/v2/mlm/deleteall	Deletes all records.
POST api/v2/mlm/replace	Replaces all records.

AeriesApi

API	Description
GET api/v1/about	Gets information about the API and Server.
GET api/v1/students/{schoolCode}	No documentation available.
GET api/v1/students/filter/id/{id}?schoolCode={schoolCode}&studentNumber={studentNumber}&firstName={firstName}&lastName={lastName}&includeEnrollmentHistory={includeEnrollmentHistory}	No documentation available.
GET api/v1/students/filter/schoolcode/{schoolCode}?studentNumber={studentNumber}&id={id}&firstName={firstName}&lastName={lastName}&includeEnrollmentHistory={includeEnrollmentHistory}	No documentation available.
GET api/v1/students/filter/schoolcode/{schoolCode}/studentnumber/{studentNumber}?id={id}&firstName={firstName}&lastName={lastName}&includeEnrollmentHistory={includeEnrollmentHistory}	No documentation available.
GET api/v1/students/filter/firstname/{firstName}?schoolCode={schoolCode}&studentNumber={studentNumber}&id={id}&lastName={lastName}&includeEnrollmentHistory={includeEnrollmentHistory}	No documentation available.
GET api/v1/students/filter/lastname/{lastName}?schoolCode={schoolCode}&studentNumber={studentNumber}&id={id}&firstName={firstName}&includeEnrollmentHistory={includeEnrollmentHistory}	No documentation available.
POST api/v1/student/search	No documentation available.
POST api/v1/student/create	No documentation available.
PUT api/v1/student/update	No documentation available.
GET api/v1/student/contacts/{schoolCode}/{studentNumber}	No documentation available.
GET api/v1/student/contacts/id/{id}	No documentation available.
PUT api/v1/student/contacts/update	No documentation available.
GET api/v1/student/con/{schoolCode}/{studentNumber}	No documentation available.
GET api/v1/student/con/id/{id}	No documentation available.
PUT api/v1/student/con/create	No documentation available.
PUT api/v1/student/con/update	No documentation available.
GET api/v1/code/all	Get all of the codes defined for the district.
GET api/v1/code/{table}?schoolCode={schoolCode}	Get all codes defined for a specific table.
GET api/v1/code/{table}/{field}?schoolCode={schoolCode}	Get all codes defined for a table and field.
GET api/v1/student/lac/{id}	No documentation available.
POST api/v1/student/lac/create	No documentation available.
PUT api/v1/student/lac/update	No documentation available.
GET api/v1/student/aut/{studentId}	No documentation available.
GET api/v1/student/aut/{schoolCode}/{studentNumber}	No documentation available.
POST api/v1/student/aut/create	No documentation available.
PUT api/v1/student/aut/update	No documentation available.
GET api/v1/student/mii/{studentId}	No documentation available.
GET api/v1/student/mii/{schoolCode}/{studentNumber}	No documentation available.
POST api/v1/student/mii/create	No documentation available.
PUT api/v1/student/mii/update	No documentation available.
GET api/v1/student/mhs/{studentId}	No documentation available.
GET api/v1/student/mhs/{schoolCode}/{studentNumber}	No documentation available.
POST api/v1/student/mhs/create	No documentation available.
PUT api/v1/student/mhs/update	No documentation available.
GET api/v1/student/ode/{id}	No documentation available.
POST api/v1/student/ode/create	No documentation available.
PUT api/v1/student/ode/update	No documentation available.
GET api/v1/student/doc/{id}	No documentation available.
GET api/v1/student/doc/{id}/{sq}	No documentation available.
POST api/v1/student/doc/create	No documentation available.
PUT api/v1/student/doc/update	No documentation available.
GET api/v1/student/sup/{schoolCode}/{studentNumber}	No documentation available.
PUT api/v1/student/sup/{schoolCode}/{studentNumber}	No documentation available.

HrnApi

Handles API requests for the HRN table.

API	Description
GET api/v2/hrn/{studentId}	Get information using the Student ID.
GET api/v2/hrn/{schoolCode}/{studentNumber}	Get information using School Code and Student Number.
PUT api/v2/hrn	Update a record.
POST api/v2/hrn	Create a new record.
DELETE api/v2/hrn	Deletes a record.
DELETE api/v2/hrn/deleteall	Deletes all records.
POST api/v2/hrn/replace	Replaces all records.

SchemaApi

Handles API requests for table schema information. This information is pulled directly from the database and may include more information than what various API calls support.

API	Description
GET api/v2/schema/{table}	Gets schema information for the specified table. This will not work for the CON table due to a reserved keyword, please use the POST call for CON details.
GET api/v2/schema/{table}/{field}	Get schema information for a single field.
POST api/v2/schema	Gets schema information for one or more tables.

StuApi

Handles API requests for the STU table.

API	Description
GET api/v2/stu/{studentId}?includeEnr={includeEnr}	Get information using the Student ID.
GET api/v2/stu/{schoolCode}/{studentNumber}?includeEnr={includeEnr}	Get information using School Code and Student Number.
POST api/v2/stu/search	Lookup students using a wide range of search options.
PUT api/v2/stu	Update a record.
POST api/v2/stu	Create a new record.

PgmApi

Handles API requests for the PGM table.

API	Description
GET api/v2/pgm/{studentId}	Get information using the Student ID.
GET api/v2/pgm/{schoolCode}/{studentNumber}	Get information using School Code and Student Number.
PUT api/v2/pgm	Update a record.
POST api/v2/pgm	Create a new record.
DELETE api/v2/pgm	Deletes a record.
DELETE api/v2/pgm/deleteall	Deletes all records.
POST api/v2/pgm/replace	Replaces all records.

VsnApi

Handles API requests for the VSN table.

API	Description
GET api/v2/vsn/{studentId}	Get information using the Student ID.
GET api/v2/vsn/{schoolCode}/{studentNumber}	Get information using School Code and Student Number.
PUT api/v2/vsn	Update a record.
POST api/v2/vsn	Create a new record.
DELETE api/v2/vsn	Deletes a record.
DELETE api/v2/vsn/deleteall	Deletes all records.
POST api/v2/vsn/replace	Replaces all records.

MhsApi

Handles API requests for the MHS table.

API	Description
GET api/v2/mhs/{studentId}	Get information using the Student ID.
GET api/v2/mhs/{schoolCode}/{studentNumber}	Get information using School Code and Student Number.
PUT api/v2/mhs	Update a record.
POST api/v2/mhs	Create a new record.
DELETE api/v2/mhs	Deletes a record.
DELETE api/v2/mhs/deleteall	Deletes all records.
POST api/v2/mhs/replace	Replaces all records.

SupApi

Handles API requests for the SUP table.

API	Description
GET api/v2/sup/{studentId}	Get information using the Student ID.
GET api/v2/sup/{schoolCode}/{studentNumber}	Get information using School Code and Student Number.
PUT api/v2/sup	Update a record.

LacApi

Handles API requests for the LAC table.

API	Description
GET api/v2/lac/{studentId}	Get information using the Student ID.
GET api/v2/lac/{schoolCode}/{studentNumber}	Get information using School Code and Student Number.
PUT api/v2/lac	Update a record.

OdeApi

Handles API requests for the ODE table.

API	Description
GET api/v2/ode/{studentId}	Get information using the Student ID.
GET api/v2/ode/{schoolCode}/{studentNumber}	Get information using the School Code and Student Number.
PUT api/v2/ode	Update a record.
POST api/v2/ode	Create a new record.
DELETE api/v2/ode	Deletes a record.
DELETE api/v2/ode/deleteall	Deletes all records.
POST api/v2/ode/replace	Replaces all records.

DocApi

Handles API requests for the DOC table.

API	Description
GET api/v2/doc/{studentId}	Get information using the Student ID.
GET api/v2/doc/{schoolCode}/{studentNumber}	Get information use the school code and student number.
GET api/v2/doc/{schoolCode}/{studentNumber}/{sq}	Get a specific item.
PUT api/v2/doc	Update a record.
POST api/v2/doc	Create a new record.
DELETE api/v2/doc	Deletes a record.

AutApi

Handles API requests for the AUT table.

API	Description
GET api/v2/aut/{studentId}	Get information using the Student ID.
GET api/v2/aut/{schoolCode}/{studentNumber}	Get information using the School Code and Student Number.
PUT api/v2/aut	Update a record.
POST api/v2/aut	Create a new record.
DELETE api/v2/aut	Deletes a record.
DELETE api/v2/aut/deleteall	Deletes all records.
POST api/v2/aut/replace	Replaces all records.

ContactApi

Handles API requests for the CON table.

API	Description
GET api/v2/contact/{studentId}	Get information using the Student ID.
GET api/v2/contact/{schoolCode}/{studentNumber}	Get information using School Code and Student Number.
PUT api/v2/contact	Update a record.
POST api/v2/contact	Create a new record.
POST api/v2/contact/replace	Replace all contacts. Uses the first contact to get ID/SC/SN information.
DELETE api/v2/contact	Deletes a record.
DELETE api/v2/contact/deleteall	Deletes all records.