Versions Compared

Old Version 1

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.

...

Overview

This API returns standardized tests that the student has taken and the scores earned.  Example tests that could be returned are ACT, SAT, placement tests, and others.

Info

Change Log

  • testProviderLInk added to v2.4.0
  • hasDetails added to v2.4.0

Get All Tests

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

Parameters

status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)Security

PERSON_TEST_READ

Returns

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"createdByschoolId" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "jwilson219",
     "firstNamename" : "John",Scholastic           "lastName" : "Doe"},
 Assessment Test",
    "createdDatetestCode" : "1332216000000SAT",
 
    "descriptionsubTestCode" : "International.LIT",
 
    "idsubTestName" : "6201b18d-9d1d-48d3-82d4-092e52ad676b"LIT",
 
    "modifiedBytakenDate" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "2012-01-01",
        "firstNamescore" : "John",
     :2059.00,
    "lastNamestatus" : "DoeAccepted"},
 
    "modifiedDateoutcome" : "1332216000000",Take       "objectStatus" : "ACTIVE",
 ENGL 102",
    "nametestProviderLink" : "Earn a 2.0 Fall Term",
 :null,
    "confidentialityLevelhasDetails" :
         {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
          "name" : "EVERYONE"}
     },
     {"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 :null},
 {"schoolId":"jwilson219",
    "createdDatename" : "1332216000000",American       "description" : "Graduate",
 College Testing",
    "idtestCode" : "c57f11e1-7ef2-4989-9ac2-7b0690563995"ACT",
 
    "modifiedByIdsubTestCode" : "91f46e39-cea8-422b-b215-00f6bcf5d280"MATH",
 
    "modifiedDatesubTestName" : "1332216000000MATH",
 
    "objectStatustakenDate" : "ACTIVE",
      "name" : "Graduate",
      "confidentialityLevel" :
         {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
    "2012-01-01",
     "namescore" : "EVERYONE"}
     },
     ...
    ]
}

 

Get a Goal

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

Returns

Goal

Code Block
{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280":19.00,
     "firstNamestatus" : "JohnAccepted",

    "lastNameoutcome" :Take "Doe"},MATH 201 "createdDate" : "1332216000000"or higher,
 "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

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

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"}, "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

...

"testProviderLink":"http://www.provider.com/details",
    "hasDetails":true}
 ]
}

 

Get Smarter Measure Test Report

GET /ssp/api/1/person/{id}/goaltest/{iddetails?testCode={testcode}&subTestCode={subtestcode}

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

...

Use
An integration has been developed with Smarter Measure to provide a link from the Placement Test tab in SSP to the actual results from a test.  SSP will generate the link within the application to the specific test.  Additional configuration is required as defined in the SSP configuration (introduced in v2.4.0)

Security

PERSON_TEST_READ

Returns

Code Block
Smarter Measure's detail report on the student's test results in html format