Return to the Index

Graduate Applicant Web Service version 3 APIs

All APIs support the optional parameter format={xml or json}

gradprograms

/api/gradprograms/

Returns a list of all the programs that the clients certificate is authorized for along with all the current and future year/quarter combinations for each program that has submitted applications along with the number of submitted applications there are for that gradprogid in that year/quarter combinations

applicants

/api/applicants?gradprogid={gradprogid}&year={year}&quarter={quarter}

Returns a list of all the applicants that have submitted applications into that the program authorized by the client certificate along with meta data about the applicant (see below). Can filtered by year, quarter and gradprogid query string parameters.

Returned Meta-data:

• appl_complete - if the application has been marked completed
• appl_qtr - the academic quarter being applied to
• appl_status - the application status code
• appl_year - the academic year being applied to
• ethnicity - the ethnicty code chosen by the applicant in the application
• ethnicity_other - additional ethnicty information provided by the applicant in the application
• firstname - the applicants first name
• grad_intent_ind - if the applicant has indicated their intent to accept an offer
• gradprogID - the graduate program id
• hispanic - the ethnicty code chosen by the applicant in the application
• hispanic_other - additional ethnicty information provided by the applicant in the application
• id - the application id
• interests - a list of any interest indicated by the applicant
• last_change_date - last change date of any of the applicant data
• lastname - applicants last name
• uri - the URL where the full application document can be found

applications

/api/applications?gradprogid={gradprogid}&year={year}&quarter={quarter}
/api/applications?applId={applId}

Returns a full application or a list of the full applicantions that have submitted by applicants for a given year, quarter and gradprogid using query string parameters. If returning a list, it requires all 3 parameters (year, quarter, gradprogid), otherwise the applId is passed in for the single application that is to be viewed.

documents

/api/documents?type={item, assessment, or unofficial_transcript}&id={documentId}

Returns a document uploaded by an applicant using the document type and document id.