Page Comparison

Get Transcript Summary

GET /ssp/api/1/person/{id}/transcript/summary

Security

PERSON_TRANSCRIPT_READ

Returns

Code Block

{"creditHoursForGPA" : "",  
 "creditHoursEarned" : "gpa",:{  "creditHoursAttempted"
: "",  "totalQualityPoints" : "",  "gradePointAverageschoolId" : "janderson218",
 "terms" : 
    [{"codecreditHoursForGpa" : "FA12":35.00,
      "coursescreditHoursAttempted" :36.00,
        [{"subjectAbbreviation" : """totalQualityPoints":85.00,
      "gradePointAverage":1.82,
      "creditHoursEarned":31.00,
    "number" : "creditCompletionRate":86.00,
      "creditHoursNotCompleted":5.00,
      "formattedCoursecurrentRestrictions" : "",

         "sectionNumberacademicStanding" : "Probation",

         "titlegpaTrendIndicator" : "Down",
          "descriptionlocalGpa" : "":1.82,
          "gradeprogramGpa" :1.82
"",    },
      "creditEarnedprograms" :[ ""}, 
        {"subjectAbbreviation" : "", 
         "numberdegreeCode" : "AUMT",

         "formattedCoursedegreeName" : "AUMT",

         "sectionNumberprogramCode" : "AUMT-AS",
          "titleprogramName" :"Associates of Science in Automotive Technology"",
          "intendedProgramAtAdmit"description:" : "",Associates of Science in Automotive Technology"
      }
   ],
"grade"  : "financialAid",:{  
        "creditEarnedschoolId" : "janderson218"},
         ..."financialAidGpa":1.82,
      "gpa20BHrsNeeded":9.00,
 ]},      {"codegpa20AHrsNeeded" : "SP13":9.00,
      "coursesneededFor67PtcCompletion" :9.00,
        [{"subjectAbbreviationcurrentYearFinancialAidAward" : "Y",

         "numbersapStatus" : "N",
          "formattedCoursefafsaDate" : "2013-08-24",
      "financialAidRemaining":809.00,
    "sectionNumber" : "originalLoanAmount":6600.00,
          "titleremainingLoanAmount" : "":5791.00,
          "descriptionbalanceOwed" : "":0.00,
          "gradefinancialAidFileStatus" : "INCOMPLETE",
      "termsLeft":8,
   "creditEarned"  : "institutionalLoanAmount"}:15000.00,
         {"subjectAbbreviationsapStatusCode" : "COUNTY_2",
          "numbereligibleFederalAid" : "Y",
     },
    "formattedCoursefinancialAidAcceptedTerms" : ""null,
   "financialAidFiles":null,
      "sectionNumberallFinancialAidTermsOutput" : "",
   "financialAidAcceptedTermsOutput":""
}

Get Full Transcript

GET /ssp/api/1/person/{id}/transcript/full

Security

PERSON_TRANSCRIPT_READ

Returns

Code Block

{  
   "titlegpa" :{ "",
  
       "descriptionschoolId" : "janderson218",
      "creditHoursForGpa":35.00,
   "grade"  : "creditHoursAttempted":36.00,
      "totalQualityPoints":85.00,
    "creditEarned" : "gradePointAverage"}:1.82,
      "creditHoursEarned":31.00,
    ...  "creditCompletionRate":86.00,
      ]}"creditHoursNotCompleted":5.00,
     ... "currentRestrictions":"",
     ]
}

Get a Goal

GET /ssp/api/1/person/{id}/goal/{id}

Returns

Goal

Code Block

{"createdBy" : "academicStanding":"Probation",
      {"idgpaTrendIndicator" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Down",
      "firstNamelocalGpa" : "John",1.82,
      "lastNameprogramGpa" : "Doe":1.82
   },
   "createdDateprograms":[  :
"1332216000000",  "description" : "Naturalized Citizen.", { "id" :
"c57f11e1-7ef2-4989-9ac2-7b0690563995",  "modifiedBy" :      {"iddegreeCode" : "91f46e39-cea8-422b-b215-00f6bcf5d280","AUMT",
         "firstNamedegreeName" : "JohnAUMT",
         "lastNameprogramCode" : "DoeAUMT-AS"},
 "modifiedDate" : "1332216000000",  "objectStatus" : "ACTIVE",  "nameprogramName" :"Associates "Earnof aScience 2.0in FallAutomotive TermTechnology",
 "confidentialityLevel"  :     { "idintendedProgramAtAdmit" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"}
}

Create a Goal

POST /ssp/api/1/person/{id}/goal

Sample Post

Code Block

{"confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995","Associates of Science in Automotive Technology"
      }
   ],
   "terms":[  
      {  
         "nameschoolId" : "EVERYONEjanderson218"},
 "name"   : "Earn a 2.0 Fall Term "subjectAbbreviation":"AUMT",
 "description"   : "Earn a 2.0 Fall Term"}

Returns

Goal

Code Block

{"id" : "5a8ecb01-e599-45a2-8d69-5e53aff3a4bc"number":"142",
 "createdDate" : "2008-04-09T12:07:56",
 "createdBy" :      {"idformattedCourse" : "91f46e39-cea8-422b-b215-00f6bcf5d280"AUMT142",
         "firstNamesectionNumber" : "John133",
     "lastName" : "Doe"}, "description" : "Earn a 2.0 Fall Term",
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedBy" :    "title":"Automotive Engine Repair",
         "description":"Introduction to Automotive Engine Repair",
         {"idgrade" : "91f46e39-cea8-422b-b215-00f6bcf5d280C-",
     "firstName" :   "JohncreditEarned":3.00,
     "lastName"  : "Doe"}, "objectStatustermCode" : "ActiveFA2012",
   "name" : "Earn a 2.0 Fall Term "creditType":"Institutional",
   "confidentialityLevel" :     {"idsectionCode" : "c57f11e1-7ef2-4989-9ac2-7b0690563995AUMT142-133",
     "name"   : "EVERYONE"}
}

Save a Goal

PUT /ssp/api/1/person/{id}/goal/{id}

Sample Post

Code Block

{"id" : "5a8ecb01-e599-45a2-8d69-5e53aff3a4bc",
 "createdDate" : "2008-04-09T12:07:56",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "description" : "Earn a 2.0 Fall Term",
 "objectStatus" : "Active",
 "name" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"}
}

Returns

Goal

Code Block

{"id" : "5a8ecb01-e599-45a2-8d69-5e53aff3a4bc",
 "createdDate" : "2008-04-09T12:07:56",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "description" : "Earn a 2.0 Fall Term",
 "objectStatus" : "Active",
 "name" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"}
}

Delete a Goal

DELETE /ssp/api/1/person/{id}/goal/{id}

Returns

Code Block
{"success" : "true"}

or

Code Block

{"success" : "false", 
 "message" : "Message when success is false." "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"etaylor310",
         "facultyName":"Elizabeth Taylor"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"AUMT",
         "number":"146",
         "formattedCourse":"AUMT146",
         "sectionNumber":"133",
         "title":"Automotive Suspension and Steering",
         "description":"Automotive Suspension and Steering",
         "grade":"C",
         "creditEarned":3.00,
         "termCode":"FA2012",
         "creditType":"Institutional",
         "sectionCode":"AUMT146-133",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"rjones330",
         "facultyName":"Robert Jones"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"AUMT",
         "number":"241",
         "formattedCourse":"AUMT241",
         "sectionNumber":"450",
         "title":"Automotive Engine Performance Analysis",
         "description":"Introduction to Auto Performance",
         "grade":"C",
         "creditEarned":3.00,
         "termCode":"FA2012",
         "creditType":"Institutional",
         "sectionCode":"AUMT241-450",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"dmartinez340",
         "facultyName":"David Martinez"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"ENG",
         "number":"055",
         "formattedCourse":"ENG055",
         "sectionNumber":"095",
         "title":"College Reading I",
         "description":"College Reading I",
         "grade":"C-",
         "creditEarned":3.00,
         "termCode":"FA2012",
         "creditType":"Developmental",
         "sectionCode":"ENG055-095",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"etaylor310",
         "facultyName":"Elizabeth Taylor"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"AUMT",
         "number":"246",
         "formattedCourse":"AUMT246",
         "sectionNumber":"190",
         "title":"Automotive Drive Train and Axles",
         "description":"Introduction to Automotive Drive Train and Axles",
         "grade":"",
         "creditEarned":3.00,
         "termCode":"FA2013",
         "creditType":"Institutional",
         "sectionCode":"AUMT246-190",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"etaylor310",
         "facultyName":"Elizabeth Taylor"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"ENG",
         "number":"076",
         "formattedCourse":"ENG076",
         "sectionNumber":"100",
         "title":"College Writing II",
         "description":"College Writing II",
         "grade":"",
         "creditEarned":3.00,
         "termCode":"FA2013",
         "creditType":"Developmental",
         "sectionCode":"ENG076-100",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"dmartinez340",
         "facultyName":"David Martinez"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"AUMT",
         "number":"142",
         "formattedCourse":"AUMT142",
         "sectionNumber":"133",
         "title":"Automotive Engine Repair",
         "description":"Introduction to Automotive Engine Repair",
         "grade":"C+",
         "creditEarned":3.00,
         "termCode":"SP2012",
         "creditType":"Institutional",
         "sectionCode":"AUMT142-133",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"etaylor310",
         "facultyName":"Elizabeth Taylor"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"ENG",
         "number":"076",
         "formattedCourse":"ENG076",
         "sectionNumber":"100",
         "title":"College Writing II",
         "description":"College Writing II",
         "grade":"C",
         "creditEarned":3.00,
         "termCode":"SP2012",
         "creditType":"Developmental",
         "sectionCode":"ENG076-100",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"dmartinez340",
         "facultyName":"David Martinez"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"GEO",
         "number":"104",
         "formattedCourse":"GEO104",
         "sectionNumber":"143",
         "title":"Introduction to Geography",
         "description":"Study of Geography",
         "grade":"C",
         "creditEarned":3.00,
         "termCode":"SP2012",
         "creditType":"Institutional",
         "sectionCode":"GEO104-143",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"jwilliams510",
         "facultyName":"Edrie Williams"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"MAT",
         "number":"086",
         "formattedCourse":"MAT086",
         "sectionNumber":"168",
         "title":"Intermediate Algebra",
         "description":"Intermediate Algebra",
         "grade":"C",
         "creditEarned":3.00,
         "termCode":"SP2012",
         "creditType":"Developmental",
         "sectionCode":"MAT086-168",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"jmartinez110",
         "facultyName":"Joseph Martinez"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"AUMT",
         "number":"244",
         "formattedCourse":"AUMT244",
         "sectionNumber":"148",
         "title":"Engine Performance Analysis II",
         "description":"Study of engine performance part II",
         "grade":"0",
         "creditEarned":3.00,
         "termCode":"SP2013",
         "creditType":"Institutional",
         "sectionCode":"AUMT244-148",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"jwilliams510",
         "facultyName":"Edrie Williams"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"AUMT",
         "number":"245",
         "formattedCourse":"AUMT245",
         "sectionNumber":"140",
         "title":"Automotive Alternative Fuels",
         "description":"Introduction to Automotive Alternative Fuels",
         "grade":"D",
         "creditEarned":3.00,
         "termCode":"SP2013",
         "creditType":"Institutional",
         "sectionCode":"AUMT245-140",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"rjones330",
         "facultyName":"Robert Jones"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"ENG",
         "number":"076",
         "formattedCourse":"ENG076",
         "sectionNumber":"225",
         "title":"College Writing II",
         "description":"College Writing II",
         "grade":"D+",
         "creditEarned":3.00,
         "termCode":"SP2013",
         "creditType":"Developmental",
         "sectionCode":"ENG076-225",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"etaylor310",
         "facultyName":"Elizabeth Taylor"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"AUMT",
         "number":"101",
         "formattedCourse":"AUMT101",
         "sectionNumber":"056",
         "title":"Introduction to Speed Communication",
         "description":"Introduction to Speed Communication",
         "grade":"B",
         "creditEarned":2.00,
         "termCode":"SP2015",
         "creditType":"Institutional",
         "sectionCode":"AUMT101-056",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"rjones210",
         "facultyName":"Ramsey Taylor"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"AUMT",
         "number":"140",
         "formattedCourse":"AUMT140",
         "sectionNumber":"139",
         "title":"Introduction to Automotive Technology",
         "description":"Introduction to Automotive Technology ",
         "grade":"C",
         "creditEarned":3.00,
         "termCode":"SP2015",
         "creditType":"Institutional",
         "sectionCode":"AUMT140-113",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"rjones330",
         "facultyName":"Robert Jones"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"ENG",
         "number":"055",
         "formattedCourse":"ENG055",
         "sectionNumber":"112",
         "title":"English Composition I",
         "description":"Preparation for College Composition",
         "grade":"C+",
         "creditEarned":2.00,
         "termCode":"SP2015",
         "creditType":"Developmental",
         "sectionCode":"ENG055-112",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"dwilson220",
         "facultyName":"Dorothy Wilson"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"ENG",
         "number":"075",
         "formattedCourse":"ENG075",
         "sectionNumber":"125",
         "title":"College Writing I",
         "description":"College Writing I",
         "grade":"C+",
         "creditEarned":3.00,
         "termCode":"SP2015",
         "creditType":"Developmental",
         "sectionCode":"ENG075-125",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"etaylor310",
         "facultyName":"Elizabeth Taylor"
      },
      {  
         "schoolId":"janderson218",
         "subjectAbbreviation":"MAT",
         "number":"085",
         "formattedCourse":"MAT085",
         "sectionNumber":"500",
         "title":"Introductory Algebra",
         "description":"Introduction to the fundamentals of Algebra",
         "grade":"B+",
         "creditEarned":1.00,
         "termCode":"SP2015",
         "creditType":"Developmental",
         "sectionCode":"MAT085-500",
         "audited":"N",
         "statusCode":"E",
         "firstName":"James",
         "lastName":"Anderson",
         "middleName":"Jacob",
         "facultySchoolId":"jmartinez110",
         "facultyName":"Joseph Martinez"
      }
   ],
   "financialAid":{  
      "schoolId":"janderson218",
      "financialAidGpa":1.82,
      "gpa20BHrsNeeded":9.00,
      "gpa20AHrsNeeded":9.00,
      "neededFor67PtcCompletion":9.00,
      "currentYearFinancialAidAward":"Y",
      "sapStatus":"N",
      "fafsaDate":"2013-08-24",
      "financialAidRemaining":809.00,
      "originalLoanAmount":6600.00,
      "remainingLoanAmount":5791.00,
      "balanceOwed":0.00,
      "financialAidFileStatus":"INCOMPLETE",
      "termsLeft":8,
      "institutionalLoanAmount":15000.00,
      "sapStatusCode":"COUNTY_2",
      "eligibleFederalAid":"Y"
   },
   "financialAidAcceptedTerms":null,
   "financialAidFiles":null,
   "nonCourseEntities":[  
      {  
         "schoolId":"janderson218",
         "targetFormattedCourse":"AES171",
         "termCode":"FA2015",
         "nonCourseCode":"PROFICIENCY",
         "title":"AES Proficiency",
         "description":"should not display",
         "grade":"PR",
         "creditEarned":0.00,
         "creditType":"PROFICIENCY",
         "statusCode":"C"
      }
   ],
   "allFinancialAidTermsOutput":"",
   "financialAidAcceptedTermsOutput":""
}

Versions Compared

Old Version 2

New Version Current

Key

Get Transcript Summary

Get Full Transcript

Get a Goal

Create a Goal

Save a Goal

Delete a Goal