| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
This page was created to contain general notes/documentation for the CAS API and Slate integration that is CAS-agnostic. It is under construction. |
...
| Expand | ||
|---|---|---|
| ||
Subject: Request to create new API account Hello, I am writing to request a new API account be created for the following CAS and institution. If possible, I’d like to request that the account username be [xxxxx]. Institution Manager name and email address: [xxxxx] Name of user to receive CAS API access: [xxxxx] CAS API user phone number: [xxxxx] CAS API user email address: [xxxxx] The name of your institution (university/college/school/etc.): [xxxxx] The CAS, one or many, that you're interested in (e.g. BusinessCAS): [xxxxx] The CAS admissions cycles you're interested in (e.g., 2020-2021 and 2021-2022): [xxxxx] The environment: [Prelaunch or Production] |
| Expand | ||
|---|---|---|
| ||
Subject: Request adding CAS to existing API account Hello, This year we will be setting up a CAS API integration for CASPA for Tufts University (program ID 346115 for 23-24). We have existing API accounts for other integrations so I am writing to request that access to CASPA be granted to the below API accounts. Prelaunch account username: TuftsUniPre Production account username: TuftsUni |
...
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
Allowed Networks (Deprecated January 2024)
Below are the IP addresses that are included in the “allowed networks” of existing CAS/Liaison Service accounts for future reference. It is unclear which exactly are used by the Liaison systems, the following list is provided for reference/troubleshooting.
...
Source Format Configurations
Data Source Formats
In Progress
Info
Data Source Formats
In Progress
| Info |
|---|
Per the Liaison API Support team 1/12/2024: Unfortunately, applicants have the ability to decide whether or not their information gets released to schools before their submission. If an applicant selects "No" for this release, then they will not show as in progress in WebADMIT and will not trigger that application.selected.file business event. |
Application
...
Documents
The document source format provided by Slate for the CAS API integration is “special” and doesn’t function the way other source formats do:
There should only be one Document source format no matter how many CAS applications are being integrated; unlike the other source formats, the documents source format should not be copied and duplicated. It can be used for all Liaision documents.
The source format appears to look at the filename of the PDF document that is sent from the CAS API to match with person and application records. For this reason, it is important not to change the file name as written in the endpoints provided by Liaison. (The exception is the text between the brackets to replace with the name of the CAS, e.g. PTCAS or CASPA).
...
Configurations
To set up the documents source format you only need to configure the Prompt Value Mappings (there are no field value mappings or other source format components to edit). Each prompt is the document type or subtype from Liaision and should be matched to whatever material type within Slate works for the school’s processes.
Document Subtypes
There are two kinds of documents for the CAS API; those that are organization-level (types) and those that are program-level (subtypes).
Organization level documents include transcripts, foreign credential evaluations, and any material required by the CAS (e.g., license or certification documents).
They should be considered “person-scoped” in Slate terminology, as they are part of the student’s profile in the CAS which is sent to all programs where they apply.
Program level documents include things required by our specific program (as configured in the configuration portal), and might include a resume, personal statment, etc.
Evaluations are also considered program-level, as they are specific to an application and some CASs do not require them (but allow a program to require them).
They should be considered application-scoped (or program-scoped) in Slate terminology, as they are specific to that application program/start-term/etc.
To determine what program needs to be mapped, review the configuration portal for the document types required by the program (available in the export file from the configuration portal). Then obtain the document subtype file from the API to match the document type to the document subtype “code.”
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Instructions for identifying program-level document subtypes and the organization-level document types are available from Liaison here: https://help.liaisonedu.com/Integration/CAS_API/CAS_Slate_Integration/Working_with_Source_Formats_and_Mapping/06_Mapping_Your_Document_Source_Format |
This table is a summary of the document types that have been used at Tufts in our API integrations.
Document Type/SubType | Response Level | Business Event | Description | CAS |
|---|---|---|---|---|
fullAppPDF | program | A comprehensive generated PDF including all information provided by the applicant in filling out the application. | ||
evaluation | program |
| A letter of recommendation. | PTCAS, SOPHAS, CASPA |
transcriptunofficial | organization |
| An unofficial transcript uploaded by the applicant. | PTCAS, SOPHAS, CASPA |
transcriptofficial | organization |
| An official transcript delivered directly to Liaison by the issuing institution. | PTCAS, SOPHAS, CASPA |
vendorTranscriptEval | organization |
| An official foreign transcript evaluation delivered directly to Liaison by the evaluation agency (WES, ECE). | PTCAS, SOPHAS, CASPA |
cv-resume |
| Resume/CV | CASPA | |
personal-statement |
| Essay/personal statement | ||
statement-of-purpose-and-objectives |
| Essay/personal statement | SOPHAS | |
other |
| Other misc. documents (optional for the applicant) | SOPHAS | |
clinical-professional | program |
| CASPA | |
unofficial-transcript | WebAdMIT | CAS Electronic Transcript (formatted like full app PDF but only containing the GPA Overview and sub-panels from WebAdMIT) | PTCAS | |
FullAppPDF | WebAdMIT | Custom PDF from WebAdMIT containing specific panels and sub-panels w/o any other documents from the application | SOPHAS, PTCAS |
FullAppPDF
The FullAppPDF document type available from the CAS API process contains the following:
Biographic information (use PDFtype=reveiwer to remove race/ethnicity)
Academic History
Supporting Information
Custom Questions (CAS)
Custom Questions (Program/Designation)
Prerequisite Courses (if available)
Evaluations
Applicant Uploaded Documents (CAS/Application Level)
Applicant Uploaded Documents (Program Level)
This document type is not customizable and is only available as-delivered. Because it does not break up documents into separate PDFs, it is not ideal for most school processes. If using a full application PDF exported out Liaison to review applications in the Reader, it may be preferable to obtain a more custom full application PDF from WebAdMIT.
Round Creation/Update
Person and Application-scoped ID and Record Matching
...