...
GET /ssp/api/1/person/{id}/goal
Security
PERSON_GOAL_READ
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)
...
| Code Block |
|---|
{"success" : "true",
"results" : "100",
"rows" :
[{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "International.",
"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"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"}
},
{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"description" : "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}
Security
PERSON_GOAL_READ
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
Security
PERSON_GOAL_WRITE
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"} |
...
| 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" : "EveryoneEVERYONE"}
} |
Save a Goal
PUT /ssp/api/1/person/{id}/goal/{id}
Security
PERSON_GOAL_WRITE
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" : "EveryoneEVERYONE"}
} |
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" : "EveryoneEVERYONE"}
} |
Delete a Goal
DELETE /ssp/api/1/person/{id}/goal/{id}
Security
PERSON_GOAL_DELETE
Returns
| Code Block |
|---|
{"success" : "true"} |
...