Request Model

The request model is what must be sent to the API to receive a filtered set of articulations.

1. Path & URL-Based Parameters
   1. Sample
   2. Base Fields
   3. Body
      1. Sample
      2. Extended Fields

Path & URL-Based Parameters

Some of the parameters to the model are embedded into the URL path of the endpoint. The request URL for searches of articulation by major should take the following form:

Sample

{domain}/api/published/in/{academicYear}/for/{receivingInstitution}

EX: prod.assistng.org/articulation/api/published/in/74/for/115

Base Fields

domain (string)

The base domain from which you are requesting the information (prod.assistng.org/articulation)

academicYear (number)

The ID of the academic year for which you wish to receive articulation (74 corresponds to academic year 23-24)

receivingInstitution (number)

The ID of the institution receiving articulation

Body

The POST body should contain a “nameFilter” parameter and optionally a “sendingInstitutionId” to restrict results to a single institution relationship if necessary.

Sample

{
  "sendingInstitutionId": 110,
  "nameFilter": "anth"
}

Extended Fields

sendingInstitutionId (number) - Optional

The ID of the sending institution to filter results

nameFilter (string) - Required

The name of the major to search for