Cheat Sheet | Quick Facts

Program IDs

Cycle opened 8/17/2023

Organization IDs

5972

App Form ID

6901

App Form ID seems to be the identifier for the CAS system (e.g., PTCAS, SOPHAS, etc.). It changes each year/cycle.

File Naming

In Progress: SOPHAS-app-started_<instanceId>_<organizationId>_<programId>_<applicationId>_<casApplicantId>.csv

App Data: PTCAS-app-s-*

Eval Data: PTCAS-app-eval-rcd-6861

GPAs: PTCAS-app-v-6861

Courses: PTCAS-BOS-courses-6861 | PTCAS-PHX-courses-6861 | PTCAS-SEA-courses-6861

Instance	Type	Subscription ID	Active	Date/Time Started
SOPHAS	In Progress	8151	Yes	`2023-09-05 14:58:31`
SOPHAS	App Data	8189	Yes	`2023-09-05 16:51:45`
SOPHAS	Documents	8214	Yes	`2023-09-08 16:34:44`

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.

In Progress Subscripton

{
    "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"
            }
        }
    ]
}

Application Data Subscription

{
    "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"
            }
        }
    ]
}

Document Subscription

{
    "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"
            }
        }
    ]
}

Replay Log

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:

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.

All applicants must have a file of data come through the In Progress source format to ensure that they have the correct Slate application record. If a file of data is not passed through the In Progress source format (subscription interruption or errors) then subsequent application data files will not create the application record as required.

It does the following:

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
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)

The In Progress source format includes a static mapping for Round: Always Create. See CAS API to Slate Integration and round configurations for more details.

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

Checklist - Fulfill

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.

Cheat Sheet | Quick Facts

CAS API Documentation

Summary

API Subscriptions

Slate Source Formats

In Progress Source Format

Application Data Source Format

Slate Rules (Automations)

Checklist - Add

Checklist - Fulfill

Application Statuses

Populations

WebAdMIT API Documentation

Summary

WebAdMIT/PTCAS Destinations

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)

0 Comments

SOPHAS API 2023 - 2024

Cheat Sheet | Quick Facts

CAS API Documentation

Summary

API Subscriptions

Slate Source Formats

In Progress Source Format

Application Data Source Format

Slate Rules (Automations)

Checklist - Add

Checklist - Fulfill

Application Statuses

Populations

WebAdMIT API Documentation

Summary

WebAdMIT/PTCAS Destinations

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)

0 Comments