Versions Compared

Old Version 6

changes.mady.by.user Julio Polo

Saved on

compared with

New Version Current

changes.mady.by.user Julio Polo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A person's name and UH Number.  RetrofitPerson is sent before any refreshStudentAcademicProfile or refreshInstructorAssignment message

ROUTING KEY: person.retrofit { "messageType":"retrofitPerson", "transmissionDate":"2016-05-09 13:58:00
Code Block
ROUTING KEY: person.refresh

{
    "messageType":"refreshPerson",
    "transmissionDate":"2016-05-09 13:58:00",
    "bannerEventNumber": ,
    "messageBody":{
        "fullName":"",
        "firstName":"",
        "preferredFirstName":"",
        "lastName":"",
        "middleName":"",
        "nameSuffix":"",
        "uhUuid":"",
        "pidm":
    }
}
Code Block

The retrofitPerson message is sent before any refreshStudentAcademicProfile or refreshInstructorAssignment message. We don't need retrofitPerson before any other type of messages because a person is either a student or faculty, and those two messages appear for a student or faculty respectively before any other type of messages (e.g. refreshStudentAcademicProfile for a student appears before any refreshStudentRegistration messages, so we don't need to send a retrofitPerson before every registration message)

NOTE: refreshPerson uses a built-in trigger which fires on events other than name changes.  You may get refreshPerson messages where the name data hasn't changed.

Code Block
ROUTING KEY: person.retrofit

{
    "messageType":"retrofitPerson",
    "transmissionDate":"2016-05-09 13:58:00",
    "bannerEventNumber": ,
    "messageBody":{
        "uhUuid":"",
        "actions":[
            {
                "messageType":"refreshPerson",
                "messageBody":{
                    "fullName":"",
                    "firstName":"",
                    "preferredFirstName":"",
                    "lastName":"",
                    "middleName":"",
                    "nameSuffix":"",
                    "uhUuid":"",
    "bannerEventNumber": ,                "pidm":
                "messageBody":{}
        "uhUuid":"",    }
    "actions":[    ]
    }
}


Students

Useful for creating groups of students by major.

Code Block
ROUTING KEY: studentAcademicProfile.refresh

{
    "messageType":"refreshStudentAcademicProfile",
    "transmissionDate":"2015-10-30 14:29:16",
        "messageType"messageBody":{
		"uhUuid":"refreshPerson12345678",
		"pidm":123456,
		"studentAcademicProfile":[
              "messageBody":{
                    "fullName":"",
                    "firstName":"",
                    "preferredFirstName":"",
                    "lastName":"",
                    "middleName":"",
                    "nameSuffix":"",
                    "uhUuid":"",
                    "pidm":
                }
            }
        ]
    }
}

 

Students

Useful for creating groups of students by major.

Code Block
ROUTING KEY: studentAcademicProfile.refresh

{
    "messageType":"refreshStudentAcademicProfile",
    "transmissionDate":"2015-10-30 14:29:16",
    "messageBody":{
		"uhUuid":"12345678",
		"pidm":123456,
		"studentAcademicProfile":[
		{
			"startingTerm":"201430",
			"endingTerm":"999999",
			"residency":"N",
			"studentStatus":"AS",
			"studentType":"C",
			"studentCurriculum":[
			{
				"priority":1,
				"org":"KAP		{
			"startingTerm":"201430",
			"endingTerm":"999999",
			"residency":"N",
			"studentStatus":"AS",
			"studentType":"C",
			"studentCurriculum":[
			{
				"priority":1,
				"org":"KAP",
				"campus":"KAP",
				"level":"UG",
				"program":"AS-NMA-ANIM",
				"major":"NMA",
				"degreeGoal":"AS",
				"college":"AR",
				"department":"AR"
			 },
			{
				"priority":2,
				"org":"MAN",
				"campus":"MAN",
				"level":"UG",
				"program":"ART-BA",
				"major":"ART",
				"degreeGoal":"BA",
				"college":"10",
				"department":"ARTH"
			}]
		},
		{
			"startingTerm":"201310",
			"endingTerm":"201430",
			"residency":"N",
			"studentStatus":"AS",
			"studentType":"C",
			"studentCurriculum":[
 			{
				"priority":1,
				"org":"KAP",
				"campus":"KAP",
				"level":"UG",
				"program":"AS-NMA-ANIM",
				"major":"NMA",
				"degreeGoal":"AS",
				"campusconcentration":"KAPANIM",
				"levelcollege":"UGAR",
				"programdepartment":"AS-NMA-ANIMAR",
			 }]
			"major":"NMA",
				"degreeGoal":"AS",
				"college":"AR",
				"department":"AR"
			 },
			{
				"priority":2,
				"org":"MAN",
				"campus":"MAN",
				"level":"UG",
				"program":"ART-BA",}]
	}
}

Registration

Code Block
ROUTING KEY: studentRegistration.refresh

{
	"messageType":"refreshStudentRegistration",
    "transmissionDate":"2015-10-30 14:29:16",
    "messageBody":{
		"uhUuid":"12345678",
		"pidm":123456,
		"term":"201430",
		 "courseList":[
			{
				"majororg":"ARTKAP",
				"degreeGoalsubjectCode":"BAMUS",
				"collegecourseNumber":"10121Z",
				"departmentcrn":"ARTH12345"
			}]
		},
		{
,
 				"startingTermcreditHours":"201310"2.0,
				"endingTermregistrationStatus":"201430RW",
				"residencywithdrawn":"N",
				"studentStatuswaitlisted":"ASN",
			"studentType":"C",}
		],
	"studentCurriculum":[
 			{
				"priority":1,
				"org":"KAP",
				"campus":"KAP",
				"level":"UG",
				"program":"AS-NMA-ANIM",
				"major":"NMA",
				"degreeGoal":"AS",
				"concentration":"ANIM",
				"college":"AR",
				"department":"AR"
			 }]
		}]
	}
}

Registration

Code Block
ROUTING KEY: studentRegistration.refresh

{
	"messageType":"refreshStudentRegistrationtotalCreditHours":2.0
	}
},

(question) Consider including sectionNumber in the courseList, it is friendlier than CRN and goes well together with subjectCode and courseNumber.

Instructor

Code Block
ROUTING KEY: instructorAssignment.refresh

{
    "messageType":"refreshInstructorAssignment",
    "transmissionDate":"2015-10-30 14:29:16",
    "bannerEventNumber":36524674,
    "messageBody":{
        "org":"HAW",
        "term":"201610",
        "subjectCode":"",
        "courseNumber":"",
        "sectionNumber":"",
        "crn":"15720",
        "transmissionDate":"2015-10-30 14:29:16",instructorList":[
            {
               "messageBody":{ 		"uhUuid":"12345678", 		"pidm":123456,
		"term":"201430",
		 "courseList":[
			{
				"org":"KAP",
				"subjectCode":"MUS",
				"courseNumber":"121Z",
				"crn":"12345",
 				"creditHours":2.0,
				"registrationStatus":"RW",
				"withdrawn":"N",
				"waitlisted":"N"
			}
		],
	"totalCreditHours":2.0
	}
},

Instructor

Code Block
ROUTING KEY: instructorAssignment.refresh

{
    "messageType":"refreshInstructorAssignment",
    "transmissionDate":"2015-10-30 14:29:16",
    "bannerEventNumber":36524674,
    "messageBody":{
                "uhUuid":"10101010",
                "lastName":"Fiction",
                "firstName":"Pulp",
                "middleName":"P",
                "primary":"Y"
            },
            {
                "pidm":155552,
                "orguhUuid":"HAW10202020",
        "term":"201610",         "subjectCodelastName":"Minde",
        "courseNumber":"",
        "sectionNumberfirstName":"Neva",
        "crn":"15720",         "instructorListpreferredFirstName":["Neva",
                {"middleName":"U",
                "pidmprimary":123456,"N"
            }
    "uhUuid":"10101010",    ]
    }
   }

Note: an empty instructorList means that there are no instructors assigned to this course section. If subjectCode, courseNumber and sectionNumber are missing, interpret this message as a course section deletion.

Course Section

Code Block
ROUTING KEY: courseSection.refresh

{
    "lastNamemessageType":"FictionrefreshCourseSection",
    "transmissionDate":"2015-10-30 14:31:20",
    "bannerEventNumber":12341322,
     "firstNamemessageBody":"Pulp",{
        "org":"MAU",
        "middleNameterm":"P201630",
       
        "primarycrn":"Y12123",
            }"subjectCode":"DENT",
        "courseNumber":"152",
   {        "sectionNumber":"0",
        "pidmsectionStatus":155552"A",
        "courseStartDate":"2016-01-11",
        "uhUuidcourseEndDate":"102020202016-05-13",
        "maximumEnrollment":12,
        "lastNamewaitlistCapacity":"Minde"0,
        "meetingTimesList":[
        "firstName":"Neva",    {
                "preferredFirstNamedays":"NevaM",
                "middleNamemeetingStartTime":"U08:00",
                "primarymeetingEndTime":"N08:50"
,
           }     "building":"NOII",
   ]     } }

Course Section

Code Block
ROUTING KEY: courseSection.refresh  {     "messageTyperoomNumber":"refreshCourseSection201",
                "transmissionDatemeetingStartDate":"20152016-10-30 14:31:2001-11",
    "bannerEventNumber":12341322,     "messageBody":{         "orgmeetingEndDate":"MAU2016-05-13",
        "term":"201630",
        "crnmeetingType":"12123",CLAS"
            "subjectCode":"DENT",},
          "courseNumber":"152",
  {
       "sectionNumber":"0",         "sectionStatusdays":"AT",
        "courseStartDate":"2016-01-11",         "courseEndDatemeetingStartTime":"2016-05-1308:00",

       "maximumEnrollment":12,         "meetingEndTime"waitlistCapacity:"11:0,
   50",
    "meetingTimesList":[             {"building":"NOII",
                 "daysroomNumber":"M",
                "meetingStartTimemeetingStartDate":"08:002016-01-11",
                "meetingEndTimemeetingEndDate":"08:502016-05-13",
                "buildingmeetingType":"NOIICLAS",
             },
  "roomNumber":"201",        ],
        "meetingStartDatetitle":"2016-01-11",
 Chairside Dent Asst"
    }
}

If subjectCode, courseNumber and sectionNumber are missing, interpret this message as a course section deletion

Published by UHIMS to the Banner exchange

Affiliation

Code Block
ROUTING KEY: affiliation.add

{
    "meetingEndDatemessageType":"2016-05-13addAffiliation",
  "messageBody":
    {
        "meetingTypeuhUuid":"CLAS10202020",
      "role":"u",
     },
 "org":"WIN"
    }
}

ROUTING KEY: affiliation.delete

{
  "messageType":"deleteAffiliation",
  "messageBody":
     {
      "daysuhUuid":"T10202020",
      "role":"u",
         "meetingStartTimeorg":"08:00WIN",
    }
}

Home Campus

Code Block
ROUTING KEY: homeCampus.add

{
  "messageType":"addHomeCampus",
   "meetingEndTime":"11:50","messageBody":
    {
      "uhUuid":"10202020",
      "buildingorg":"NOIIWIN",
    }
}

ROUTING KEY: homeCampus.modify

{
    "roomNumbermessageType":"modifyHomeCampus",
  "messageBody":
      {
      "meetingStartDateuhUuid":"2016-01-1110202020",
         "org":"WIN",
      "meetingEndDateoldOrg":"2016-05-13LEE",
    }
}

ROUTING KEY: homeCampus.delete

{
    "meetingTypemessageType":"CLASdeleteHomeCampus",
  "messageBody":
    {
    },
        ]  "uhUuid":"10202020",
        "titleorg":"Chairside Dent AsstWIN"
    }
}