Get All Early Alert Referral Reasons
GET /ssp/api/1/reference/referralReasonsearlyAlertReferralReason
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
List<ReferralReason>List<EarlyAlertReferralReason>
| Code Block |
|---|
[{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Academic Concern",
"description" : "Academic concern",
"sortOrder" : 1},
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Excessive Absences",
"description" : "Excessive absences",
"sortOrder" : 2},
...
] |
Get
...
an Early Alert Referral Reason
GET /ssp/api/1/reference/referralReasonearlyAlertReferralReason/{id}
Returns
ReferralReasonEarlyAlertReferralReason
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Academic Concern",
"description" : "Academic concern",
"sortOrder" : 1} |
Create
...
an Early Alert Referral Reason
POST /ssp/api/1/reference/referralReasonearlyAlertReferralReason
Sample Post
| Code Block |
|---|
{"description" : "Low test scores.",
"name" : "Low Test Scores"} |
Returns
ReferralReasonEarlyAlertReferralReason
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Low Test Scores",
"description" : "Low test scores.",
"sortOrder" : 3} |
Save
...
an Early Alert Referral Reason
PUT /ssp/api/1/reference/referralReasonearlyAlertReferralReason/{id}
Sample Post
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Academic Concern",
"description" : "Academic concern",
"sortOrder" : 1} |
Returns
ReferralReasonEarlyAlertReferralReason
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Academic Concern",
"description" : "Academic concern",
"sortOrder" : 1} |
Delete
...
an Early Alert Referral Reason
DELETE /ssp/api/1/reference/referralReasonearlyAlertReferralReason/{id}
Returns
| Code Block |
|---|
{"ServiceResponse" :
{"success" : "true"}} |
or
| Code Block |
|---|
{"ServiceResponse" :
{"success" : "false",
"message" : "Message when success is false."}} |