Versions Compared

Old Version 5

changes.mady.by.user Alexander Leader

Saved on

compared with

New Version Current

changes.mady.by.user Jason Elwood

Saved on

Key

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

Get Transcript Summary


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

Security

PERSON_TRANSCRIPT_READ

Returns

Code Block
{"degreeCode" : "BS",  
   "gpa":{  
      "programCodeschoolId" : "MAJ-BUS2346janderson218",
 "programName"  : "Mathematics",  "creditHoursForGPAcreditHoursForGpa" : 1535.00,
  "creditHoursEarned" : 15.00,  "creditHoursAttempted" : 1536.00,
      "totalQualityPoints" : 4585.00,
      "gradePointAverage" : 31.0082,
 "terms" :      [{"codecreditHoursEarned" : "FA12":31.00,
      "coursescreditCompletionRate" :86.00,
        [{"subjectAbbreviationcreditHoursNotCompleted" : "MTH",
   :5.00,
      "numbercurrentRestrictions" : "101",
   
      "formattedCourseacademicStanding" : "MTH-101Probation",
          "sectionNumbergpaTrendIndicator" : "01Down",
      "localGpa":1.82,
   "title"  : "College Algebra",programGpa":1.82
     },
    "descriptionprograms":[ : "College
level algebra for students entering an arts{ program", 
         "gradedegreeCode" : "B-AUMT",

         "creditEarneddegreeName" : "2.70AUMT"},
         {"subjectAbbreviationprogramCode" : "ACCTAUMT-AS",
          "programName"number:" : "1000"Associates of Science in Automotive Technology",
          "intendedProgramAtAdmit"formattedCourse:" : "ACCT1000",Associates of Science in Automotive Technology"
      }
   ],
 "sectionNumber" : "20financialAid",:{  
        "titleschoolId" : "Introduction to Accountingjanderson218",
          "descriptionfinancialAidGpa":1.82,
:  "Introduction to basic accounting practices.""gpa20BHrsNeeded":9.00,
          "gradegpa20AHrsNeeded" : "A":9.00,
          "creditEarnedneededFor67PtcCompletion" : "49.00"},
      "currentYearFinancialAidAward":"Y",
  ...    "sapStatus":"N",
    ]},      {"code" : "SP13"fafsaDate":"2013-08-24",
      "coursesfinancialAidRemaining" :809.00,
        [{"subjectAbbreviationoriginalLoanAmount" : "BW":6600.00,
      "remainingLoanAmount":5791.00,
    "number" : "103balanceOwed":0.00,

         "formattedCoursefinancialAidFileStatus" : "BW-103INCOMPLETE",
      "termsLeft":8,
   "sectionNumber"  : "02institutionalLoanAmount":15000.00,
          "titlesapStatusCode" : "Introduction to Basket Weaving"COUNTY_2",
          "descriptioneligibleFederalAid" : "Y"In
this class students will},
learn the fine techniques required in the modern basket-weaving industry." "financialAidAcceptedTerms":null,
   "financialAidFiles":null,
    "allFinancialAidTermsOutput":"",
     "gradefinancialAidAcceptedTermsOutput" : "A-",
  "
}

Get Full Transcript

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

Security

PERSON_TRANSCRIPT_READ

Returns

Code Block
{  
   "gpa":{  
      "creditEarnedschoolId" : "3.70janderson218"},
         {"subjectAbbreviation" : "ENG""creditHoursForGpa":35.00,
      "creditHoursAttempted":36.00,
   "number"  : "111totalQualityPoints":85.00,
      "gradePointAverage":1.82,
   "formattedCourse"  : "ENG111creditHoursEarned":31.00,
      "creditCompletionRate":86.00,
    "sectionNumber" : "AcreditHoursNotCompleted":5.00,
          "title" : "English Composition I"currentRestrictions":"",
          "descriptionacademicStanding" : "Introduction to composition and writing techniques."Probation",
 
        "gradegpaTrendIndicator" : "BDown",
  
       "creditEarnedlocalGpa" : "3.00"}1.82,
         ..."programGpa":1.82
   },
    ]},"programs":[  
     ... {  
 ] }

 

Get a Goal

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

Returns

Goal

Code Block
{"createdBy" :      {"iddegreeCode" : "91f46e39-cea8-422b-b215-00f6bcf5d280"AUMT",
     "firstName"   : "JohndegreeName":"AUMT",
         "lastNameprogramCode" : "DoeAUMT-AS"},
 "createdDate" : "1332216000000",        "descriptionprogramName" : "Naturalized Citizen.",
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995Associates of Science in Automotive Technology",
 "modifiedBy"  :      {"idintendedProgramAtAdmit" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "Associates of Science in Automotive Technology"
  "firstName" : "John",  }
   "lastName"],
: "Doe"},  "modifiedDateterms" :[ "1332216000000", 
"objectStatus" : "ACTIVE",  "name" : "Earn{ a 2.0
Fall Term",  "confidentialityLevel" :     {"idschoolId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995"janderson218",
         "namesubjectAbbreviation" : "EVERYONE"}
}

 

Create a Goal

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

Sample Post

Code Block
{"confidentialityLevel" :AUMT",
         {"idnumber" : "c57f11e1-7ef2-4989-9ac2-7b0690563995","142",
         "nameformattedCourse" : "EVERYONEAUMT142"},
 "name"   : "Earn a 2.0 Fall Term "sectionNumber":"133",
 "description"   : "Earn a 2.0 Fall Term"}

Returns

Goal

Code Block
{"id" : "5a8ecb01-e599-45a2-8d69-5e53aff3a4bc",
 "createdDate" : "2008-04-09T12:07:56",
 "createdBy" :"title":"Automotive Engine Repair",
         "description":"Introduction to Automotive Engine Repair",
         {"idgrade" : "91f46e39-cea8-422b-b215-00f6bcf5d280"C-",
     "firstName"   : "JohncreditEarned":3.00,
     "lastName" : "Doe"}, "description" : "Earn a 2.0 Fall Term",
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedBy" :    "termCode":"FA2012",
         "creditType":"Institutional",
         {"idsectionCode" : "91f46e39-cea8-422b-b215-00f6bcf5d280AUMT142-133",
         "firstNameaudited" : "JohnN",
     "lastName" : "Doe"}, "objectStatus" : "Active  "statusCode":"E",
         "firstName":"James",
 "name"   : "Earn a 2.0 Fall Term "lastName":"Anderson",
   "confidentialityLevel" :     {"idmiddleName" : "c57f11e1-7ef2-4989-9ac2-7b0690563995"Jacob",
         "namefacultySchoolId" : "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.""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":""
}