Get All
...
Tests
GET /ssp/api/1/person/{id}/goal
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)
test
Returns
| Code Block |
|---|
{"success" : "true",
"results" : "100",
"rows" :
[{"createdBycode" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "International.",
"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b"ACT",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "EarnAmerican a 2.0 Fall TermCollege Test",
"confidentialityLevelsubTestCode" :
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"ENG",
"nametakenDate" : "EVERYONE"}
},
{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"descriptionscore" : "Graduate",
"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Graduate",
"confidentialityLevel" :
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"name" : "EVERYONE"}
},
...
]
} |
Get a Goal
GET /ssp/api/1/person/{id}/goal/{id}
Returns
Goal
| Code Block |
|---|
{"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
| Code Block |
|---|
{"confidentialityLevel" : {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "name" : "EVERYONE"}, "28"}, {"code" : "ACT", "name" : "EarnAmerican a 2.0 Fall TermCollege Test", "description" : "Earn a 2.0 Fall Term"} |
Returns
Goal
| Code Block |
|---|
{"id"subTestCode" : "5a8ecb01-e599-45a2-8d69-5e53aff3a4bcMATH", "createdDate" : "2008-04-09T12:07:56", "createdBy" : {"idtakenDate" : "91f46e39-cea8-422b-b215-00f6bcf5d2801332216000000", "firstName" : "Johnscore", "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
| 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.": "24"}, ... ] } |