SOPHAS API

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

Instance

Type

Subscription ID

Active

Date/Time Started

SOPHAS

In Progress

20993

Yes

2024-08-14 10:15:23

SOPHAS

Received

21029

Yes

2024-08-14 16:50:49

SOPHAS

Complete

21030

Yes

2024-08-14 16:50:54

SOPHAS

Verified

20131

Yes

2024-08-14 16:51:00

SOPHAS

Updated

20132

Yes

2024-08-14 16:51:04

SOPHAS

Documents - Evaluations

20133

Yes

2024-08-14 16:53:44

SOPHAS

Documents - Transcripts

20134

Yes

2024-08-14 16:53:48

SOPHAS

Documents - Statement/CV

20135

Yes

2024-08-14 16:55:30

CAS API Documentation

Summary

API Subscriptions

There are three separate API subscriptions created for this cycle, outlined below.

Subscription

Business Event

Description

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.

{ "notificationEmailAddress": "tts-slate-team@elists.tufts.edu", "subscriptionDetails": [ { "destinationType": "SFTP", "event": "application.program.selected", "responseLevel": "program", "responseType": "fullResponse", "responseOptions": "expand=all,includeNulls=true,contentType=text/csv,columnSeparator=COMMA,csvHeaderTruncationSize=4,csvShortName=question", "apiVersion": "v2", "sftpDestination": { "sftpHost": "ft.technolutions.net", "sftpPort": 22, "sftpUser": "liaison_service@tusmgp.admissions.tufts.edu", "sftpPassword": "2717fef375e24a1ab89a376a86cbe358", "sftpBaseDirectory": "/incoming/liaison/SOPHAS/data/", "sftpPathTemplate": "SOPHAS-app-started_<instanceId>_<organizationId>_<programId>_<applicationId>_<casApplicantId>!<deliveredDate>.csv" } } ] }
{ "notificationEmailAddress": "tts-slate-team@elists.tufts.edu", "subscriptionDetails": [ { "destinationType": "SFTP", "event": "application.program.received", "responseLevel": "program", "responseType": "fullResponse", "responseOptions": "expand=all,includeNulls=true,contentType=text/csv,columnSeparator=COMMA,csvHeaderTruncationSize=4,csvShortName=question", "apiVersion": "v2", "sftpDestination": { "sftpHost": "ft.technolutions.net", "sftpPort": 22, "sftpUser": "liaison_service@tusmgp.admissions.tufts.edu", "sftpPassword": "2717fef375e24a1ab89a376a86cbe358", "sftpBaseDirectory": "/incoming/liaison/SOPHAS/data", "sftpPathTemplate": "SOPHAS-app-s-received_<instanceId>_<organizationId>_<programId>_<applicationId>_<casApplicantId>.csv" } }, { "destinationType": "SFTP", "event": "application.program.completed", "responseLevel": "program", "responseType": "fullResponse", "responseOptions": "expand=all,includeNulls=true,contentType=text/csv,columnSeparator=COMMA,csvHeaderTruncationSize=4,csvShortName=question", "apiVersion": "v2", "sftpDestination": { "sftpHost": "ft.technolutions.net", "sftpPort": 22, "sftpUser": "liaison_service@tusmgp.admissions.tufts.edu", "sftpPassword": "2717fef375e24a1ab89a376a86cbe358", "sftpBaseDirectory": "/incoming/liaison/SOPHAS/data", "sftpPathTemplate": "SOPHAS-app-s-complete_<instanceId>_<organizationId>_<programId>_<applicationId>_<casApplicantId>.csv" } }, { "destinationType": "SFTP", "event": "application.program.verified", "responseLevel": "program", "responseType": "fullResponse", "responseOptions": "expand=all,includeNulls=true,contentType=text/csv,columnSeparator=COMMA,csvHeaderTruncationSize=4,csvShortName=question", "apiVersion": "v2", "sftpDestination": { "sftpHost": "ft.technolutions.net", "sftpPort": 22, "sftpUser": "liaison_service@tusmgp.admissions.tufts.edu", "sftpPassword": "2717fef375e24a1ab89a376a86cbe358", "sftpBaseDirectory": "/incoming/liaison/SOPHAS/data", "sftpPathTemplate": "SOPHAS-app-s-verified_<instanceId>_<organizationId>_<programId>_<applicationId>_<casApplicantId>.csv" } }, { "destinationType": "SFTP", "event": "application.updated", "dataHold": "InProgress,Received,Complete", "responseLevel": "program", "responseType": "fullResponse", "responseOptions": "expand=all,includeNulls=true,contentType=text/csv,columnSeparator=COMMA,csvHeaderTruncationSize=4,csvShortName=question", "apiVersion": "v2", "sftpDestination": { "sftpHost": "ft.technolutions.net", "sftpPort": 22, "sftpUser": "liaison_service@tusmgp.admissions.tufts.edu", "sftpPassword": "2717fef375e24a1ab89a376a86cbe358", "sftpBaseDirectory": "/incoming/liaison/SOPHAS/data/", "sftpPathTemplate": "SOPHAS-app-s-updated_<instanceId>_<organizationId>_<programId>_<applicationId>_<casApplicantId>!<deliveredDate>.csv" } } ] }
{ "notificationEmailAddress": "tts-slate-team@elists.tufts.edu", "subscriptionDetails": [ { "destinationType": "SFTP", "event": "file.attachment.updated", "responseLevel": "organization", "responseType": "fullResponse", "dataHold": "InProgress", "sftpDestination": { "sftpHost": "ft.technolutions.net", "sftpPort": 22, "sftpUser": "liaison_service@tusmgp.admissions.tufts.edu", "sftpPassword": "2717fef375e24a1ab89a376a86cbe358", "sftpBaseDirectory": "/incoming/liaison/", "sftpPathTemplate": "SOPHAS_pers_<casApplicantId>__<documentSubType>__<fileId>!<deliveredDate>.pdf" } }, { "destinationType": "SFTP", "event": "file.supplementalAttachment.updated", "responseLevel": "program", "responseType": "fullResponse", "dataHold": "InProgress", "sftpDestination": { "sftpHost": "ft.technolutions.net", "sftpPort": 22, "sftpUser": "liaison_service@tusmgp.admissions.tufts.edu", "sftpPassword": "2717fef375e24a1ab89a376a86cbe358", "sftpBaseDirectory": "/incoming/liaison/", "sftpPathTemplate": "SOPHAS_app_<casApplicantId>_<programId>_<documentSubType>__<fileId>!<deliveredDate>.pdf" } }, { "destinationType": "SFTP", "event": "file.evaluation.updated", "responseLevel": "program", "responseType": "fullResponse", "dataHold": "InProgress", "sftpDestination": { "sftpHost": "ft.technolutions.net", "sftpPort": 22, "sftpUser": "liaison_service@tusmgp.admissions.tufts.edu", "sftpPassword": "2717fef375e24a1ab89a376a86cbe358", "sftpBaseDirectory": "/incoming/liaison/", "sftpPathTemplate": "SOPHAS_app_<casApplicantId>_<programId>_<docType>__<fileId>!<deliveredDate>.pdf" } }, { "destinationType": "SFTP", "event": "file.transcript.updated", "responseLevel": "organization", "responseType": "fullResponse", "dataHold": "InProgress", "sftpDestination": { "sftpHost": "ft.technolutions.net", "sftpPort": 22, "sftpUser": "liaison_service@tusmgp.admissions.tufts.edu", "sftpPassword": "2717fef375e24a1ab89a376a86cbe358", "sftpBaseDirectory": "/incoming/liaison/", "sftpPathTemplate": "SOPHAS_pers_<casApplicantId>__<docType><transcriptType>_<collegeAttendedId>_<fileId>!<deliveredDate>.pdf" } }, { "destinationType": "SFTP", "event": "file.vendorTranscriptEval.updated", "responseLevel": "organization", "responseType": "fullResponse", "dataHold": "InProgress", "sftpDestination": { "sftpHost": "ft.technolutions.net", "sftpPort": 22, "sftpUser": "liaison_service@tusmgp.admissions.tufts.edu", "sftpPassword": "2717fef375e24a1ab89a376a86cbe358", "sftpBaseDirectory": "/incoming/liaison/", "sftpPathTemplate": "SOPHAS_pers_<casApplicantId>__<docType>_<collegeAttendedId>_<fileId>!<deliveredDate>.pdf" } } ] }

Instance

Subscription ID

Replay ID

From

To

Status

Date

Notes

Instance

Subscription ID

Replay ID

From

To

Status

Date

Notes

SOPHAS

8151

8256

2023-08-25 12:24:10

2023-09-05 14:58:31

Done

2023-09-05 15:02:26

Restart IP import and backdate to when data failed due to domain name change

SOPHAS

8189

8257

2023-08-24 08:59:08

2023-09-05 16:51:45

Done

2023-09-05 16:53:44

Restart the application data feed and backdate to when data failed due to domain name change

SOPHAS

8214

8269

2023-08-24 08:59:08

2023-09-08 16:34:44

Done

2023-09-08 16:37:31

Restart document feed and backdate to when data failed due to domain name change

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:

  1. SOPHAS In Progress

  2. SOPHAS Application

  3. 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:

  1. Creates/updates the person record with the following information:

    1. BioDemo data (name, sex, date of birth, addresses, phone/email, citizenship)

    2. CAS/Liaison Person ID (see Record Matching)

    3. Inquiry Details

      1. Program of Interest

    4. Updates person status to Applicant

    5. Adds an interaction code to track creation of an In Progress application

  2. Creates an application record on the person record with the following information:

    1. CAS/Liaision Application ID (see Record Matching)

    2. Application Round

    3. Sets application submitted flag to “No”

    4. Application Created date

    5. Application Details (program, start term/year, CAS/Liaison Status, CAS/Liaison Application Program ID)

Slate Destination

CAS API Field

 

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

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

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 SFTP Documentation

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