Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Get Transcript

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

Returns

{"degreeCode" : "BS",
 "programCode" : "MAJ-BUS2346",
 "programName" : "Mathematics",
 "creditHoursForGPA" : 15.00,
 "creditHoursEarned" : 15.00,
 "creditHoursAttempted" : 15.00,
 "totalQualityPoints" : 45.00,
 "gradePointAverage" : 3.00,
 "terms" : 
    [{"code" : "FA12",
      "courses" :
        [{"subjectAbbreviation" : "MTH",
          "number" : "101",
          "formattedCourse" : "MTH-101",
          "sectionNumber" : "01",
          "title" : "College Algebra",
          "description" : "College level algebra for students entering an arts program",
          "grade" : "B-",
          "creditEarned" : "2.70"},
         {"subjectAbbreviation" : "ACCT",
          "number" : "1000",
          "formattedCourse" : "ACCT1000",
          "sectionNumber" : "20",
          "title" : "Introduction to Accounting",
          "description" : "Introduction to basic accounting practices.",
          "grade" : "A",
          "creditEarned" : "4.00"},
         ...
        ]},
     {"code" : "SP13",
      "courses" :
        [{"subjectAbbreviation" : "BW",
          "number" : "103",
          "formattedCourse" : "BW-103",
          "sectionNumber" : "02",
          "title" : "Introduction to Basket Weaving",
          "description" : "In this class students will learn the fine techniques required in the modern basket-weaving industry.",
          "grade" : "A-",
          "creditEarned" : "3.70"},
         {"subjectAbbreviation" : "ENG",
          "number" : "111",
          "formattedCourse" : "ENG111",
          "sectionNumber" : "A",
          "title" : "English Composition I",
          "description" : "Introduction to composition and writing techniques.",
          "grade" : "B",
          "creditEarned" : "3.00"},
         ...
        ]},
     ...
    ]
}

 

Get a Goal

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

Returns

Goal

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "createdDate" : "1332216000000",
 "description" : "Naturalized Citizen.",
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"}
}

 

Create a Goal

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

Sample Post

{"confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"},
 "name" : "Earn a 2.0 Fall Term",
 "description" : "Earn a 2.0 Fall Term"}

Returns

Goal

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

 

Save a Goal

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

Sample Post

{"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

{"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

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}
  • No labels