SOPHAS API
- 1 Cheat Sheet | Quick Facts
- 2 CAS API Documentation
- 2.1 Summary
- 2.2 API Subscriptions
- 2.3 Slate Source Formats
- 2.4 Slate Rules (Automations)
- 2.4.1 Checklist - Add
- 2.4.2 Checklist - Fulfill
- 2.4.3 Application Statuses
- 2.4.4 Populations
- 3 WebAdMIT API Documentation
- 3.1 Summary
- 3.2 WebAdMIT/PTCAS Destinations
- 3.3 WebAdMIT/PTCAS Configurations for Data Exports
- 3.3.1 List Configurations
- 3.3.2 API: Evaluation Received
- 3.3.3 API: Prerequisite Courses
- 3.3.4 API: CAS Calculated GPAs
- 3.3.5 Manual: PDF Exports
- 3.4 Slate Source Formats
- 3.5 Slate Batch Acquire
- 3.6 Slate Rules (Automations)
- 4 Cycle Notes by Year
Cheat Sheet | Quick Facts
Program IDs
Each concentration, start term, and program format has a separate program ID. See chart.
CAS API: progMate.progSele0.programID
WebAdMIT: Designation > Program Identifier
Organization IDs
5972
Cycle Dates
Cycle Open: 8/13/2024
Cycle Close: mid-August
File Naming Conventions
Business Event/FIle | Source | Filename |
---|---|---|
In Progress | API | SOPHAS-app-started_* |
Received | API | PTCAS-app-s-received_7198* |
Completed | API | PTCAS-app-s-completed_7198* |
Verified | API | PTCAS-app-s-verified_7198* |
Updated | API | PTCAS-app-s-updated_7198* |
Verified post-prereq | WebAdMIT | PTCAS-app-v-7198-[PROG].csv |
Courses post-prereq | WebAdMIT | PTCAS-courses-7198-[PROG].csv |
Evaluations update | WebAdMIT | PTCAS-app-eval-rcd-7198-[PROG].csv |
Full App PDF post-prereq | WebAdMIT | PTCAS-docs-fullapp-7198-[PROG].zip |
CAS Tx PDF post-prereq | WebAdMIT | PTCAS-docs-CASpretx-7198-[PROG].zip |
Instance | Type | Subscription ID | Active | Date/Time Started |
---|---|---|---|---|
SOPHAS | In Progress | 20993 | Yes |
|
SOPHAS | Received | 21029 | Yes |
|
SOPHAS | Complete | 21030 | Yes |
|
SOPHAS | Verified | 20131 | Yes |
|
SOPHAS | Updated | 20132 | Yes |
|
SOPHAS | Documents - Evaluations | 20133 | Yes |
|
SOPHAS | Documents - Transcripts | 20134 | Yes |
|
SOPHAS | Documents - Statement/CV | 20135 | Yes |
|
CAS API Documentation
Summary
API Subscriptions
There are three separate API subscriptions created for this cycle, outlined below.
Subscription | Business Event | Description |
---|---|---|
In Progress | application.program.selected | Complete file of available application data is sent when applicant selects program and “adds to their shopping cart.” Can be understood as the first step in applying to a program. |
Application Data | application.program.received, application.program.completed, application.program.verified, application.program.updated | Complete file of available application data is sent when applicant/application moves through Liaison/CAS application benchmarks/statuses (Received, Complete, Verified, Updated). Updated files are sent only after the applicant reached “Verification” status. |
Documents |
|
|
Below are the GET requests (HTTP methods) used to set up these subscriptions. They are modified from the Postman Collection provided by Liaision in the CAS API Integration Center updated on 8/29/2023.
Slate Source Formats
There are three source formats configured in Slate TUP to translate and load the data sent by the API into records and applications in Slate:
SOPHAS In Progress
SOPHAS Application
All CAS Documents
In Progress Source Format
The In Progress source format is configured to create the initial person and application record for an applicant in Slate.
It does the following:
Creates/updates the person record with the following information:
BioDemo data (name, sex, date of birth, addresses, phone/email, citizenship)
CAS/Liaison Person ID (see Record Matching)
Inquiry Details
Program of Interest
Updates person status to Applicant
Adds an interaction code to track creation of an In Progress application
Creates an application record on the person record with the following information:
CAS/Liaision Application ID (see Record Matching)
Application Round
Sets application submitted flag to “No”
Application Created date
Application Details (program, start term/year, CAS/Liaison Status, CAS/Liaison Application Program ID)
Slate Destination | CAS API Field |
|
---|---|---|
CAS/Liaison Application ID | casApplicantID + progMate.progSele0.programID |
|
CAS/Liaison Application Program ID | progMate.progSele0.programID |
|
CAS/Liaison Application Status | progMate.progSele0.submissionStatus |
|
App - Concentration | progMate.progSele0.name |
|
App - Program | progMate.progSele0.delivery | On-Campus = Master of Public Health Online = Master of Public Health (Online) |
App - Start Term/Year | progMate.progSele0.startTerm + progMate.progSele0.academicYear | Fall / Summer / Spring + 2024 |
App - Created Date | progMate.progSele0.createdDate |
|
App - Accelerated | progMate.progSele0.name |
|
Inquiry Details - Concentration Interest | progMate.progSele0.name |
|
Inquiry Details - Format Interest | progMate.progSele0.delivery | On-Campus = Online = |
Inquiry Details - Planned Entry Term | progMate.progSele0.startTerm + progMate.progSele0.academicYear | Fall / Summer / Spring + 2024 |
Application Data Source Format
Slate Rules (Automations)
Checklist - Add
All checklist items are added by a Rule in Slate.
Rule | Filter Critera | Notes |
---|---|---|
Add Full Application | IN active period, program is MPH or O-MPH NOT IN referral program = TUSM Faculty, app tag = deferred enrollment or special circumstances | Uses the “Full Application” checklist group. |
Add Recommendations | IN active period, program is MPH or O-MPH NOT IN referral program = TUSM Faculty or PA Transfer, app tag = deferred enrollment or special circumstances | Uses the “Recommendations - 3” checklist group. |
Add Verification | IN active period, program is MPH or O-MPH NOT IN referral program = TUSM Faculty or PA Transfer, app tag = deferred enrollment or special circumstances | Uses the “Verified by CAS” checklist group. |
Add Proof English Proficiency (PEP) | IN active period, program is MPH or O-MPH NOT IN referral program = TUSM Faculty or PA Transfer, app tag = deferred enrollment or special circumstances, native language = English | Uses the “PEP Required” checklist group. Will add if native language is anything other than English, including NULL. Sometimes applicants accidentally select “middle english” (why is this an option?!)
|
Add Foreign Credential Evaluation (FCE) | IN active period, program is MPH or O-MPH, degree from non-US institution = Yes NOT IN referral program = TUSM Faculty or PA Transfer, app tag = deferred enrollment or special circumstances | Uses the “FCE Required” checklist group. |
Add Official Test Scores |
| Program has determined they are optional, removed MPH programs from this rule 1/9/2024 |
Checklist - Fulfill
Checklist items can be fulfilled either via a Rule, or by criteria built within the checklist item itself.
Rule | Filter Criteria | Notes |
---|---|---|
Fulfill Verification | IN active period, program is MPH or O-MPH, CAS/Liaison Application Status = Verified or Deferral |
|
Fulfill Recommendations | IN active period, program is MPH or O-MPH, has 3 or more application-scoped Materials = Recommendation (All) | Uses dependent subquery to count the total if greater than or equal to 3. Note that this is different than the Slate-built reference table, materials, and process; this is a regular application-scoped material for generic recommendations which we created custom for TUP. |
Application Statuses
Populations
WebAdMIT API Documentation
Summary
WebAdMIT/PTCAS Destinations
SOPHAS is configured with a “destination” that allows for that instance to send data a host via SFTP; the Destination has been configured to the same settings as used for the CAS API, including the same authentication user/password and the same paths/endpoint. All data sent via the WebAdMIT API appears in the same location in the SFTP server that the CAS API files appear.
WebAdMIT/PTCAS Configurations for Data Exports
List Configurations
API: Evaluation Received
API: Prerequisite Courses
API: CAS Calculated GPAs
Manual: PDF Exports
Slate Source Formats
Slate Batch Acquire
Slate Rules (Automations)
Cycle Notes by Year
2023 - 2024
Application Form ID = 6901, cycle opened 8/17/2023