Get Agreement

Get a published articulation agreement by key.

Api

Route

/articulation/api/Agreements

Method

GET

Key Required

No

Common Response

Yes

Response Type

Validated Response of PublishedAgreementDataModel

Query Parameters

key (string)

URL encoded composite key of an agreement, composed of the academic year, sending institution, receiving institution, agreement type, and an ID. Agreement keys are returned from Get List of Agreements.

Curl Examples

curl -X 'GET' \
  'https://prod.assistng.org/articulation/api/Agreements?Key=74%2F110%2Fto%2F7%2FDepartment%2F13008' \
  -H 'accept: application/json'

• Key (decoded) = 74/110/to/7/Department/13008 (the key as provided for the Visual Arts department agreement from the Get List of Agreements API call)

Sample Response

{
  "result": {
    "name": "Visual Arts",
    "type": "Department",
    "publishDate": "2023-11-29T20:47:45.4758894",
    "receivingInstitution": "{\"id\":7,\"code\":\"UCSD    \",\"isCommunityCollege\":false,\"category\":\"UC\",\"termTyp...",
    "sendingInstitution": "{\"id\":110,\"code\":\"AHC     \",\"isCommunityCollege\":true,\"category\":\"CCC\",\"termTyp...",
    "academicYear": "{\"id\":74,\"code\":\"2023-2024\",\"beginDate\":\"2023-10-01T00:00:00\",\"endDate\":\"2024-10-01T0",
    "templateAssets": null,
    "articulations": "[{\"type\":\"Course\",\"course\":{\"courseIdentifierParentId\":289351,\"courseTitle\":\"Introduct...",
    "catalogYear": "{\"receivingCatalogYearBegin\":2023,\"receivingCatalogYearEnd\":2024,\"sendingCatalogYearBegin\":20..."
  },
  "validationFailure": null,
  "isSuccessful": true
}

Fields

result (PublishedAgreementDataModel)

The data model of the requested published agreement. Click the model type name for a full breakdown of the model itself.