Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get All Early Alert

...

Reasons

GET /ssp/api/1/reference/earlyAlertReferralReasonearlyAlertReason

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<EarlyAlertReferralReason>List<EarlyAlertReason>

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

...

Reason

GET /ssp/api/1/reference/earlyAlertReferralReasonearlyAlertReason/{id}

Returns

EarlyAlertReferralReasonEarlyAlertReason

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

...

Reason

POST /ssp/api/1/reference/earlyAlertReferralReasonearlyAlertReason

Sample Post

Code Block
{"description" : "Low test scores.",
 "name" : "Low Test Scores"}

Returns

EarlyAlertReferralReasonEarlyAlertReason

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

...

Reason

PUT /ssp/api/1/reference/earlyAlertReferralReasonearlyAlertReason/{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

EarlyAlertReferralReasonEarlyAlertReason

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

...

Reason

DELETE /ssp/api/1/reference/earlyAlertReferralReasonearlyAlertReason/{id}

Returns

Code Block
{"success" : "true"}

...