Get Articulation by Major
Agreements and the Receiving and Sending articulation they contain are organized by both Academic Year and Institution.
The Get Articulation By Major API allows the caller to search through active Agreements and articulation in the system using the provided parameters.
Api
- Route
/published/api/in/{academicYear:int}/for/{receivingInstitution:int}
- Method
- POST
- Input Body
- Request Model
- Key Required
- Yes
- Common Response
- No
- Response Type
- Published Agreement Model
Sample Response
{
"result": {
"receivingInstitution": {
"id": 115,
"code": "HSU ",
"isCommunityCollege": false,
"category": "CSU",
"termType": "Semester",
"names": [
{
"name": "Humboldt State University",
"hasDepartments": true,
"fromYear": 0,
"hideInList": false
},
{
"name": "California Polytechnic University, Humboldt",
"hasDepartments": true,
"fromYear": 2021,
"hideInList": false
}
],
"termTypeAcademicYears": [
{
"termType": "Semester",
"fromYear": 2021
},
...
]
},
"academicYear": null,
"publishedMajorAgreements": [
{
"sendingInstitution": {
"id": 110,
"code": "AHC ",
"isCommunityCollege": true,
"category": "CCC",
"termType": "Semester",
"names": [
{
"name": "Allan Hancock College",
"hasDepartments": true,
"fromYear": 0,
"hideInList": false
}
],
"termTypeAcademicYears": [
{
"termType": "Quarter",
"fromYear": 2021
},
{
"termType": "Semester",
"fromYear": 2016
},
...
]
},
"majors": [
{
"key": "74/110/to/115/Major/54dcad5b-7ab1-4356-a539-c076b2406aa2",
"name": "Anthropology B.A.",
"agreementUri": "/articulation/api/agreements?Key=74%2F110%2Fto%2F115%2FMajor%2F54dcad5b-7ab1-4356-a539-c076b2406aa2",
"articulations": [
{
"type": "Course",
"course": {
"courseIdentifierParentId": 375657,
"courseTitle": "Introduction to the Anthropology Major",
"courseNumber": "210",
"prefix": "ANTH",
"prefixParentId": null,
"prefixDescription": "Anthropology",
"departmentParentId": null,
"department": "Anthropology, Geography, World Languages & Cultures",
"begin": "F2021",
"end": "",
"beginDate": null,
"beginTermId": null,
"endDate": null,
"endTermId": null,
"minUnits": 1,
"maxUnits": 1,
"isTerminated": false,
"hasOutline": false,
"crossListedCourses": null
},
"visibleCrossListedCourses": [],
"courseAttributes": [],
"sharedArticulations": null,
"id": null,
"lastSignOff": null,
"receivingInstitutionParentId": null,
"sendingInstitutionParentId": null,
"academicYearId": null,
"notes": [],
"isDraft": false,
"isHiddenFromPrefixAndDepartment": false,
"isHiddenFromMajor": false,
"sendingArticulation": {
"id": "00000000-0000-0000-0000-000000000000",
"noArticulationReasonId": null,
"noArticulationReason": "No Course Articulated",
"deniedCourses": [],
"items": [],
"courseGroupConjunctions": [],
"type": "SendingArticulation",
"attributes": []
},
"templateOverrides": [],
"attributes": [],
"receivingAttributes": []
},
...
]
}
]
}
]
},
"validationFailure": null,
"isSuccessful": true
}
Published Agreement Model
- receivingInstitution (Institution)
- Represents the institution receiving articulation
- publishedMajorAgreements (List of Agreements)
- A list of all major agreements that fit the given search parameters including sending institution and all articulation associated with each agreement.
Other fields included in these results can be ignored.
Curl
curl -X 'POST' \ 'https://prod.assistng.org:44374/articulation/api/Published/in/74/for/115' \ -H 'accept: text/plain' \ -H 'Content-Type: application/json-patch+json' \ -d '{ "sendingInstitutionId": 110, "nameFilter": "anth" }'