...
GET /ssp/api/1/reference/journalTrack
Security
SERVICE_REFERENCE_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)
...
GET /ssp/api/1/reference/journalTrack/{id}
Security
SERVICE_REFERENCE_READ
Returns
JournalTrack
| Code Block |
|---|
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "1332216000000",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Individualized Learning Plan",
"description" : "Individualized Learning Plan",
"sortOrder" : 1} |
...
POST /ssp/api/1/reference/journalTrack
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"name" : "Individualized Learning Plan",
"description" : "Individualized Learning Plan",
"sortOrder" : 1} |
...
PUT /ssp/api/1/reference/journalTrack/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "1332216000000",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Individualized Learning Plan",
"description" : "Individualized Learning Plan",
"sortOrder" : 1} |
...
| Code Block |
|---|
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "1332216000000",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Individualized Learning Plan",
"description" : "Individualized Learning Plan",
"sortOrder" : 1} |
Delete a Journal Track
DELETE /ssp/api/1/reference/journalTrack/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"success" : "true"} |
or
| Code Block |
|---|
{"success" : "false",
"message" : "Message when success is false."} |
Add a Journal Step to a Journal Track
POST /ssp/api/1/reference/journalTrack/{id}/journalStep
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66"} |
Returns
| Code Block |
|---|
{"success" : "true"} |
or
| Code Block |
|---|
{"success" : "false",
"message" : "Message when success is false."} |
Remove a Journal Step from a Journal Track
DELETE /ssp/api/1/reference/journalTrack/{id}/journalStep
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66"} |
Returns
| Code Block |
|---|
{"success" : "true"} |
...