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 PublishedAgreementDataResponseModel

Query Parameters

key (string)

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.

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

Full details of the response are on the PublishedAgreementDataResponseModel page.