Sending Articulations

This page contains documents the models found on the sending side of the articulation.

  1. Sending Articulation Model
    1. Sample
    2. Fields
  2. Course Group Conjunction
    1. Sample
    2. Fields
  3. Sending Articulation Item Base Model
    1. Sample
    2. Base Fields
  4. Sending Articulation Course Group
    1. Sample
    2. Fields
    3. Sending Articulation Course Group Item Base Model
      1. Sample
      2. Base Fields
    4. Sending Articulation Course Group Item Course
      1. Sample
      2. Extended Fields
    5. Sending Articulation Course Group Item Advisement
      1. Sample
      2. Extended Fields
  5. Sending Articulation Advisement Item
    1. Sample
    2. Extended Fields
  6. Sending Template Articulation
    1. Sample
    2. Extended Fields

Sending Articulation Model

This model composes all the data on the sending side of the articulation.

Sample

{
  "noArticulationReason": null,
  "deniedCourses": [],
  "items": [],
  "courseGroupConjunctions": [],
  "type": "SendingArticulation",
  "attributes": []
}

Fields

noArticulationReason (string)
The reason why this articulation has no sending articulation. This field should be null if it has been articulated
deniedCourses (Array of DeniedCourse)
An array of courses that have explicitly been denied
items (Array of SendingArticulationItem)
An array of sending articulation items that is polymorphic to the type of sending articulation it is
courseGroupConjunctions (Array of Course Group Conjunction )
An array of conjunctions that can be applied between the array of sending articulation items
type (enum)
The type of SendingArticulation from [SendingArticulation,TemplateOverride]
attributes (Array of Attribute)
Cell-level attributes associated to the sending side of the articulation

Course Group Conjunction

This model composes the defined conjunction for a group of courses on an articulation. Sample Course Group Conjunction

Sample

{
    "id": "d9f0d2ba-0833-4503-94c2-ed5d2e895dc6",
    "sendingArticulationId": "07f602b2-6ffe-42de-834d-ddfb20ab0798",
    "groupConjunction": "Or",
    "sendingCourseGroupBeginPosition": 0,
    "sendingCourseGroupEndPosition": 1
}

Fields

id (guid)
The unique id for the course group conjunction
sendingArticulationId (guid)
The unique id for the sending articulation id in which this conjunction belongs
groupConjunction (enum)
The conjunction type from [And,Or]
sendingCourseGroupBeginPosition (number)
The first position in which the conjunction applies
sendingCourseGroupEndPosition (number)
The last position in which the conjunction applies

Sending Articulation Item Base Model

The base sending articulation model contains fields that are common to all sending articulation items.

Sample

{
    "position": 0,
    "type": "Course",
    ...

}

Base Fields

position (number)
The position in the array that the sending item should display
type (enum)
The type of sending articulation item from [CourseGroup,Advisement]

Sending Articulation Course Group

This model extends the Sending Articulation Item if the sending articulation type is a CourseGroup.

Sample

{
    "courseConjunction": "And",
    "items": [],
    "attributes": [],
    ...
}

Fields

courseConjunction (enum)
The conjunction relationship for the items from [And,Or]
items (Array of Sending Articulation Course Group Item)
The items in this course group
attributes (Array of Attribute)
The attributes related to this course group

Sending Articulation Course Group Item Base Model

The model that represents a sending articulation item in a course group. This model is the base model in which other Course Group Items are derived.

Sample

{
    "position": 0,
    "type": "Course",
    ...
}

Base Fields

position (number)
The position in the array that the sending item should display
type (enum)
The type of sending articulation item from [Course,Advisement]

Sending Articulation Course Group Item Course

The model that represents a sending course item in a course group. This model extends Sending Articulation Course Group Item Base Model and is the model used when the group item type is Course.

Sample

{
    "visibleCrossListedCourses": [],
    "requisites": [],
    "attributes": [
        {
            "position": 0,
            "content": "Lower division credit only"
        }
    ],
    "courseIdentifierParentId": 305118,
    "courseTitle": "Organic Chemistry I",
    "courseNumber": "180",
    "prefix": "CHEM",
    "prefixParentId": 3851,
    "prefixDescription": "Chemistry",
    "departmentParentId": 2356,
    "department": "Chemistry",
    "begin": "F2013",
    "end": "",
    "minUnits": 5.00,
    "maxUnits": 5.00,
    "publishedCourseIdentifierYearTermId": null,
}

Extended Fields

visibleCrossListedCourses (Array of Course)
The cross listed courses to show the “Same as” on the sending articulation
requisites (Array of Requisite Course)
The pre-requisite and co-requisite courses associated with this course
attributes (Array of Attribute)
The attributes associated with this course
courseIdentifierParentId (number)
The unique id of the course in which versions can be derived
courseTitle (string)
The title of the course
courseNumber (string)
The course number
prefix (date)
The prefix
prefixParentId (number)
The unique id of this course’s prefix in which prefix versions can be derived
prefixDescription (string)
The description of the prefix associated with this course
departmentParentId (number)
The unique id of this course’s department in which department versions can be derived
department (string)
The department title
begin (string)
The yearTermCode in which this course version becomes active
end (string)
The yearTermCode in which this course version ceases to be active
If end is blank then this course version continues indefinitely. If end is populated with a yearTermCode, that could either mean that a future course version continues this course version forward, likely with a revision, or the course is terminated.
minUnits (number)
The minimum units
maxUnits (number)
The maximum units
publishedCourseIdentifierYearTermId (number)
The yearTermId that this course version applies to, usually null when there’s not a midyear revision for the course

Sending Articulation Course Group Item Advisement

The model that represents a sending advisement in a course group. This model extends Sending Articulation Course Group Item Base Model and is the model used when the course group item type is an Advisement.

Sample

{
    "advisement": {}
    ...
}

Extended Fields

advisement (Advisement)
The advisement object which is polymorphic to the type of advisement it is

Sending Articulation Advisement Item

This model extends the Sending Articulation Item if the sending articulation type is an Advisement.

Sample

{
    "advisement": {}
    ...
}

Extended Fields

advisement (Advisement)
The advisement object which is polymorphic to the type of advisement it is

Sending Template Articulation

This model represents the template override for sending articulation on template agreements (Major and General Education). Typically, the articulations defined on a template agreements are pulled from existing defined articulations from Department and Prefix Agreements. However, articulation officers have the option to override those articulations with a different articulation on specific Major and General Education agreements. This model represents that override.

Sample

{
    "id": "9ed46f47-0d43-48a4-d7f6-08dba8a2fddc",
    "variantIds": [
        "794842ef-c525-4bc1-98f1-50e65cd59233"
    ],
    "sendingArticulation": {
        "noArticulationReason": null,
        "deniedCourses": [],
        "items": [],
        "courseGroupConjunctions": [],
        "type": "TemplateOverride",
        "attributes": []
    }
}

Extended Fields

id (guid)
The unique id of this override
variantIds (Array of guid)
The array of template variant Ids that are associated with this override
sendingArticulation (Sending Articulation)
The Sending Articulation to override the articulation’s sendingArticulation with