Get All
...
Early Alert Reasons
GET /ssp/api/1/reference/referralReasonsearlyAlertReason
Security
SERVICE_REFERENCE_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>return
limit : Maximum number of results to return<br>return
sort : Property name<br>name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
ReturnsList<ReferralReason>
| Code Block |
|---|
{"success" : "true", "results" : "100", "rows" : [{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "createdBy" : {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "modifiedByIdmodifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "objectStatus" : "ACTIVE", "name" : "Academic Concern", "description" : "Academic concern", "sortOrder" : 1}, {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "createdBy" : {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "modifiedById"modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "objectStatus" : "ACTIVE", "name" : "Excessive Absences", "description" : "Excessive absences", "sortOrder" : 2}, ... ] } |
Get
...
an Early Alert Reason
GET /ssp/api/1/reference/referralReasonearlyAlertReason/{id}
Security
SERVICE_REFERENCE_READ
Returns
ReferralReasonEarlyAlertReason
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdByIdcreatedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedByIdmodifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Academic Concern",
"description" : "Academic concern",
"sortOrder" : 1} |
Create
...
an Early Alert Reason
POST /ssp/api/1/reference/referralReasonearlyAlertReason
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"description" : "Low test scores.",
"name" : "Low Test Scores"} |
Returns
ReferralReasonEarlyAlertReason
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdBy" :
{"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedById"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Low Test Scores",
"description" : "Low test scores.",
"sortOrder" : 3} |
Save
...
an Early Alert Reason
PUT /ssp/api/1/reference/referralReasonearlyAlertReason/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdByIdcreatedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedByIdmodifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Academic Concern",
"description" : "Academic concern",
"sortOrder" : 1} |
Returns
ReferralReasonEarlyAlertReason
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Academic Concern",
"description" : "Academic concern",
"sortOrder" : 1} |
Delete
...
an Early Alert Reason
DELETE /ssp/api/1/reference/referralReasonearlyAlertReason/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"ServiceResponse" :
{"success" : "true"}} |
or
| Code Block |
|---|
{"ServiceResponse" :
{"success" : "false",
"message" : "Message when success is false."}} |