Get All Journal Step Details
GET /ssp/api/1/reference/journalStepDetail
Security
SERVICE_REFERENCE_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>
limit : Maximum number of results to return<br>
sort : Property name<br>
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
Returns
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "aa4cbb22-f5bf-4510-8f99-9dfce1d2bba6",
"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" : "Action Plan Developed",
"description" : "Action plan developed with student.",
"sortOrder" : 1},
{"id" : "12965f9c-f801-4203-bc6e-abb69ac75281",
"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" : "Discussed Financial Aid Information",
"description" : "Discussed financial aid information with student and determined any additional financial needs."
"sortOrder" : 1},
{"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
"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" : "Follow-Up Appointment Made",
"description" : "Follow-up appointment made with student."
"sortOrder" : 1},
...
]
}
Get All Journal Step Details For Journal Step
GET /ssp/api/1/reference/journalStep/{id}/journalStepDetails
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)
Returns
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "aa4cbb22-f5bf-4510-8f99-9dfce1d2bba6",
"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" : "Action Plan Developed",
"description" : "Action plan developed with student.",
"sortOrder" : 1},
{"id" : "12965f9c-f801-4203-bc6e-abb69ac75281",
"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" : "Discussed Financial Aid Information",
"description" : "Discussed financial aid information with student and determined any additional financial needs."
"sortOrder" : 1},
...
]
}
Get One Journal Step Detail
GET /ssp/api/1/reference/journalStepDetail/{id}
Security
SERVICE_REFERENCE_READ
Returns
JournalStepDetail
{"id" : "aa4cbb22-f5bf-4510-8f99-9dfce1d2bba6",
"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" : "Action Plan Developed",
"description" : "Action plan developed with student.",
"sortOrder" : 1}
Create a Journal Step Detail
POST /ssp/api/1/reference/journalStepDetail
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"name" : "Action Plan Developed",
"description" : "Action plan developed with student.",
"sortOrder" : 1}
Returns
JournalStepDetail
{"id" : "aa4cbb22-f5bf-4510-8f99-9dfce1d2bba6",
"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" : "Action Plan Developed",
"description" : "Action plan developed with student.",
"sortOrder" : 1}
Save a Journal Step Detail
PUT /ssp/api/1/reference/journalStepDetail/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"id" : "aa4cbb22-f5bf-4510-8f99-9dfce1d2bba6",
"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" : "Action Plan Developed",
"description" : "Action plan developed with student.",
"sortOrder" : 1}
Returns
JournalStepDetail
{"id" : "aa4cbb22-f5bf-4510-8f99-9dfce1d2bba6",
"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" : "Action Plan Developed",
"description" : "Action plan developed with student.",
"sortOrder" : 1}
Delete a Journal Step Detail
DELETE /ssp/api/1/reference/journalStepDetail/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}