Versions Compared

Key

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

...

Security

PERSON_MAP_READ

Parameters

status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return

Returns

Code Block
{
   "success":"true",
  "message":"",
"results":110,
   "rows":[
 
    {

        "id":"58ba5ee30a90940a-734e3efe-4ae91520-b9c5813f-943774b4de4100be6828005a",
         "createdDate":13312692000001370107045928,

        "createdBy":{
            "id":"91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
            "firstName":"JohnAmy",
            "lastName":"DoeAdministrator"

        },

        "modifiedDate":13312692000001370966161353,
         "modifiedBy":{
            "id":"91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
            "firstName":"JohnAmy",
            "lastName":"DoeAdministrator"

        },

        "objectStatus":"ACTIVE",

        "personIdname":"b3c888f8-5056-a51a-8061-00a5435f98d9Plan for Graduation",

        "ownerId": "da5728700a90940a-56993efc-11e2175f-be1e813e-406c8f22c3cefc1ac581000b",
         "contactTitleownerName":"Ms.Amy Administrator",

        "contactNamecontactTitle":"Joan JamesMr",
         "contactPhonecontactName":"(212) 555-1234",
Mike Smith",
        "contactPhone":"212-555-1212",
        "contactEmail":"johnadvisor@institution.james@hkjhfe.comedu",
         "contactNotes":"CallAdvisor before NoonNotes",

        "namestudentNotes":"John Doe's Path To SuccessStudent Notes",

        "isOnPlanisFinancialAid":falsetrue,
         "studentNotesisImportant":"Summer classes may help complete the program quicker",
true,
        "isF1Visa":true,
        "academicGoals":"Graduate from a 4 year universityGoal",

        "offPlanReasonacademicLink":"John had to pick up extra hours at work.",
academic link",
        "isFinancialAidcareerLink":true"career link",
         "isImportantisValid":true,
         "isF1VisatermNotes":false[],

        "careerLinkpersonId":"http://www.careers.com/dental_hygenist64a97729-7999-4b31-b70b-f0b705dff288",
         "academicLinkcourses":"http://www.academics.com/dental_hygenist_classes"
      }
   ]
}null }
	...
	]
}

Get All Plans (MAP)

Description

...

Code Block
{
   "success":"true",
   "results":110,
   "rows":[
  
   {
  
      "id":"58ba5ee30a90940a-734e3fc7-4ae91f00-b9c5813f-943774b4de41ca10fee70002",
         "createdDate":13312692000001373484678888,
 
       "createdBy":{
     
      "id":"91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
            "firstName"firstName":"JohnAmy",
     
      "lastName":"Doe"
     Administrator"
   },
         "modifiedDate":13312692000001373484778372,
         "modifiedBy":{

           "id":"91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
            "firstName":"JohnAmy",
            "lastName":"Doe"
     Administrator"
   },

        "objectStatus":"ACTIVE",
   "name":"Sample Plan",
    "personIdownerId":"b3c888f80a90940a-50563efc-a51a175f-8061813e-00a5435f98d9fc1ac581000b",
     "ownerName":"Amy Administrator",
   "ownerIdcontactTitle":"Advisor",
"da572870-5699-11e2-be1e-406c8f22c3ce   "contactName":"John Smith",
         "contactTitle"contactPhone":"Ms.212-555-1212",
         "contactName"contactEmail":"Joan Jamesadvisor@college.edu",
     
   "contactPhonecontactNotes":"(212) 555-1234",
         "contactEmail":"john.james@hkjhfe.com",
         "contactNotes":"Call before Noon",
         "name":"John Doe's Path To Success",
         "isOnPlan":false,
         "studentNotes":"Summer classes may help complete the program quicker",
         "academicGoals":"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",
               "courseCode":"BIO128_12345"
               "formattedCourse":"BIO128",
               "courseTitle":"Cell Biology",
               "courseDescription":"Cell Biology Description", 
			   "orderInTerm":1,
               "creditHours":5,
               "isTranscript":true,
               "studentNotes":"This class can be difficult if you haven't taken BIO in HS",
               "contactNotes":"Advise student to brush up on HS BIO",
               "isImportant":true,
               "isDevAdvisor Plan Notes",
   "studentNotes":"Student Plan Notes",
   "isFinancialAid":true,
   "isImportant":true,
   "isF1Visa":true,
   "academicGoals":"Goals for Academics",
     "electiveIds":[ {"id":"1d93a1b5-a2d9-11e2-8d55-406c8f22c3ce"}"academicLink":"http://www.college.edu/academic.html",
   "careerLink":"http://www.college.edu/career.html",
   "isValid":true,
   "termNotes":[
             {
         {"id":"2b69aff50a90940a-a2d93efc-11e2175f-a881813e-406c8f22c3ce") ],fc1ac581000b",
         "firstName":"Amy",
         "termCodelastName":"FA-13Administrator"
      },
   "objectStatus":"ACTIVE",
 }  "studentNotes":"Student Term Notes",
   "contactNotes":"Advisor Term ]Notes",
   "termCode":"FA2013",
    "isImportant":true},
   "termNotesplanCourses":[
    
       {
               "id":"ce0d041d0a90940a-d3ac3fc7-42a11f00-9085813f-7f744240e07eca1283680016",
     
         "createdDate":1331269200000,
     1373484778344,
         "createdBy":{
     
            "id":"91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
     
            "firstName":"JohnAmy",
     
            "lastName":"DoeAdministrator"},
      "modifiedDate":1373484778344,
      "modifiedBy":{
 },        "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
         "modifiedDatefirstName":1331269200000,
     "Amy",
         "modifiedBylastName":{"Administrator"},
      "objectStatus":"ACTIVE",
      "termCode":"FA2013",
      "idcourseCode":"91f46e39-cea8-422b-b215-00f6bcf5d280IEE-105",
           "formattedCourse":"IEE105",
      "firstNamecourseTitle":"John",
   Analytical Industrial Engineering",
      "courseDescription":" ",
      "lastNamestudentNotes":"DoeAdvisor Student Notes",
      "contactNotes":"Advisor Course Notes",
      }"isImportant":true,
       "isTranscript":false,
       "objectStatuselectiveId":"ACTIVE"
        3bdda584-f7a2-4402-8863-4b5bd8273009",
      "isImportantcreditHours":false2.00,
        "isDev":true,
      "termCodeorderInTerm":"FA-13"1,
        "planToOffer":null,
      "studentNotespersonId":"John is also working full time this semester64a97729-7999-4b31-b70b-f0b705dff288",
        "duplicateOfTranscript":false,
      "contactNotesdev":"Johntrue,
is at risk because of outside commitments"isValidInTerm":true,
      "hasPrerequisites":true,
     } "hasCorequisites":true,
        ]
      "invalidReasons":""}
	  ...
	]
}

 

Get Plan (MAP) Current

...