Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Response payload modifications based on discussion in off-list "MAP API Deltas" thread

...

Code Block
{
   "success":"true",
   "results":1,
   "rows":[
      {
         "id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
         "createdDate":1331269200000,
         "createdBy":{
            "id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName":"John",
            "lastName":"Doe"
         },
         "modifiedDate":1331269200000,
         "modifiedBy":{
            "id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName":"John",
            "lastName":"Doe"
         },
         "objectStatus":"ACTIVE",
         "personId":"b3c888f8-5056-a51a-8061-00a5435f98d9",
         "ownerId": "da572870-5699-11e2-be1e-406c8f22c3ce",
         "contactTitle":"Ms.",
         "contactName":"Joan James",
         "contactPhone":"(212) 555-1234",
         "contactEmail":"john.james@hkjhfe.com",
         "contactNotes":"Call before Noon",
         "isAccepted":true,
         "planNamename":"John Doe's Path To Success",
         "dateAccepted":1331269200000,
         "totalTermCreditHours":105,
         "isOnPlan":false,
         "studentNotes":"Summer classes may help complete the program quicker",
         "isPledge":false,
         "academicGoalacademicGoals":"Graduate from a 4 year university",
         "offPlanReason":"John had to pick up extra hours at work.",
         "isFinancialAid":true,
         "isImportant":true,
         "isF1Visa":false,
         "careerLink":"http://www.careers.com/dental_hygenist",
         "academicLink":"http://www.academics.com/dental_hygenist_classes"
      }
   ]
}

...

Code Block
{
   "success":"true",
   "results":1,
   "rows":[
      {
         "id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
         "createdDate":1331269200000,
         "createdBy":{
            "id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName":"John",
            "lastName":"Doe"
         },
         "modifiedDate":1331269200000,
         "modifiedBy":{
            "id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName":"John",
            "lastName":"Doe"
         },
         "objectStatus":"ACTIVE",
         "personId":"b3c888f8-5056-a51a-8061-00a5435f98d9",
         "ownerId": "da572870-5699-11e2-be1e-406c8f22c3ce",
         "contactTitle":"Ms.",
         "contactName":"Joan James",
         "contactPhone":"(212) 555-1234",
         "contactEmail":"john.james@hkjhfe.com",
         "contactNotes":"Call before Noon",
         "isAccepted":true,
         "planNamename":"John Doe's Path To Success",
         "dateAccepted":1331269200000,
         "totalTermCreditHours":105,
         "isOnPlan":false,
         "studentNotes":"Summer classes may help complete the program quicker",
         "isPledge":false,
         "academicGoalacademicGoals":"Graduate from a 4 year university",
         "offPlanReason":"John had to pick up extra hours at work.",
         "isFinancialAid":true,
         "isImportant":true,
         "isF1Visa":false,
         "careerLink":"http://www.careers.com/dental_hygenist",
         "academicLink":"http://www.academics.com/dental_hygenist_classes",
         "planCourses":[
            {
               "id":"ce0d041d-d3ac-42a1-9085-7f744240e07e",
               "createdDate":1331269200000,
               "createdBy":{
                  "id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
                  "firstName":"John",
                  "lastName":"Doe"
               },
               "modifiedDate":1331269200000,
               "modifiedBy":{
                  "id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
                  "firstName":"John",
                  "lastName":"Doe"
               },
               "objectStatus":"ACTIVE",
               "personId":"b3c888f8-5056-a51a-8061-00a5435f98d9",
               "formattedCoursecourseCode":"BIO128_12345",
               "courseTitleformattedCourse":"Cell BiologyBIO128",
 			      "order":1,        "courseTitle":"Cell Biology",
      "maxCreditHours":5,         "courseTitle":"Cell Biology Description", 
			   "totalCreditHoursorderInTerm":51,
               "changedCreditHourscreditHours":05,
               "isTranscript":true,
               "notesstudentNotes":"This class can be difficult if you haven't taken BIO in HS",
               "notesForAdvisorcontactNotes":"Advise student to brush up on HS BIO",
               "isImportant":true,
               "isCriticalisDev":true,
               "isPElective":false,"electiveIds":[ {"id":"1d93a1b5-a2d9-11e2-8d55-406c8f22c3ce"},
                               {"courseTypeIdid":"b3c888f82b69aff5-5056a2d9-a51a11e2-8061a881-00a5435f98d9406c8f22c3ce") ],
               "termCode":"FA-13"
            }
         ],
         "termNotes":[
            {
               "id":"ce0d041d-d3ac-42a1-9085-7f744240e07e",
               "createdDate":1331269200000,
               "createdBy":{
                  "id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
                  "firstName":"John",
                  "lastName":"Doe"
               },
               "modifiedDate":1331269200000,
               "modifiedBy":{
                  "id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
                  "firstName":"John",
                  "lastName":"Doe"
               },
               "isCriticalobjectStatus":"ACTIVE"
               "isImportant":false,
               "termCode":"FA-13",
               "notesstudentNotes":"John is also working full time this semester",
               "termNotesForAdvisorscontactNotes":"John is at risk because of outside commitments"
            }
         ]
      }
   ]
}

...