| 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. |
| Table of Contents |
|---|
Common Terms and Definitions
...
Term
...
Definition
...
CAS association
...
The group that owns and manages the CAS (e.g., APTA for PTCAS, ASPPH for SOPHAS, etc.)
...
Organization ID
...
Associated with the school/institution (e.g., Tufts University). Indicates the institution’s entity within the CAS/cycle. A unique ID used in setting up API accounts and subscriptions. Remains the same across cycles.
...
Application Form ID
...
Associated with the CAS/cycle (e.g., the PTCAS application for 23-24), represents the configurations made by the CAS association for their centralized application for that cycle, a unique ID used in setting up API accounts and subscriptions. Each year/cycle it will change for the CAS, but within that cycle it is the same for any program within that CAS (i.e., the individual DPT programs use the same application form ID because it is for PTCAS and not the program itself).
...
Application ID
...
Prelaunch environment
...
Prelaunch is a "staging" environment that allows you to configure programs for the new cycle without impacting the current cycle.
...
Production environment
...
The "live environment" is where you perform your applicant review processes.
API Configurations
CAS API Account (Liaison)
To configure subscriptions and gain access to the CAS API data Liaison requires a “CAS API Account.” Access to a specific CAS environment (production or prelaunch) is granted to this account.
An Institution Manager (IM) for each CAS must reqest either a new account or that access be given to an existing account for their CAS. However, the CAS API Account itself can have a different “owner” than the IM. If the owner will be different than the IM, the owner will need to already have access to the environment(s) in their existing Liaison/WebAdMIT account. It may be necessary for the IM to request access for the owner from the CAS association (i.e., PTCAS staff) before submitting the API account request.
Each CAS will have an organization code to identify it. So for example, PTCAS 23-24 for PHX has one organization ID, and PTCAS 23-24 for SEA has a different organization ID.
A separate account is required for production vs. prelaunch (which is a test environment available before the cycle opens), but it is possible to have multiple CAS and cycles under a single account.
Once access for a CAS/organization is added to the account, it will “roll over” each year when the new cycle is added, so this process only needs to happen once per CAS/organization.
...
| 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. |
| Table of Contents |
|---|
Common Terms and Definitions
Term | Definition |
|---|---|
CAS association | The group that owns and manages the CAS (e.g., APTA for PTCAS, ASPPH for SOPHAS, etc.) |
Organization ID | Associated with the school/institution (e.g., Tufts University). Indicates the institution’s entity within the CAS/cycle. A unique ID used in setting up API accounts and subscriptions. Remains the same across cycles. |
Application Form ID | Associated with the CAS/cycle (e.g., the PTCAS application for 23-24), represents the configurations made by the CAS association for their centralized application for that cycle, a unique ID used in setting up API accounts and subscriptions. Each year/cycle it will change for the CAS, but within that cycle it is the same for any program within that CAS (i.e., the individual DPT programs use the same application form ID because it is for PTCAS and not the program itself). |
Application ID | |
Prelaunch environment | Prelaunch is a "staging" environment that allows you to configure programs for the new cycle without impacting the current cycle. |
Production environment | The "live environment" is where you perform your applicant review processes. |
API Configurations
CAS API Account (Liaison)
To configure subscriptions and gain access to the CAS API data Liaison requires a “CAS API Account.” Access to a specific CAS environment (production or prelaunch) is granted to this account.
| Note |
|---|
An Institution Manager (IM) for each CAS must reqest either a new account or that access be given to an existing account for their CAS. However, the CAS API Account itself can have a different “owner” than the IM. If the owner will be different than the IM, the owner will need to already have access to the environment(s) in their existing Liaison/WebAdMIT account. It may be necessary for the IM to request access for the owner from the CAS association (i.e., PTCAS staff) before submitting the API account request. |
Each CAS will have an organization code to identify it. So for example, PTCAS 23-24 for PHX has one organization ID, and PTCAS 23-24 for SEA has a different organization ID.
A separate account is required for production vs. prelaunch (which is a test environment available before the cycle opens), but it is possible to have multiple CAS and cycles under a single account.
Once access for a CAS/organization is added to the account, it will “roll over” each year when the new cycle is added, so this process only needs to happen once per CAS/organization.
Access to each cycle’s prelaunch environment and production environment will depend on when it is “opened” as part of the cycle (see Cycle Turnover Process).
Sample Tickets
Send to apisupport@liaisonedu.com.
| 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 reqest 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 |
CAS API Accounts Managed by TTS Slate Team
...
| 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.
...