Page Comparison

...

GET /ssp/api/1/person/{id}/earlyAlert

Security

PERSON_EARLY_ALERT_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<EarlyAlert>

Code Block

[{"idsuccess" : "6201b18d-9d1d-48d3-82d4-092e52ad676b"true",
  "createdBy" : 
"message":"","results":1,
 "rows":
    [{"id" : "91f46e3984ace006-cea81a36-422b4acc-b21583a7-00f6bcf5d2802d87abfcf3c2",
      "firstName" : "JohncreatedDate":1347964903568,
      "lastNamecreatedBy" :
"Doe"},
  "createdDate" : "1332216000000",   "modifiedBy" :       {"id" : "91f46e39f02058a4-cea876e5-422b4d06-b21597d2-00f6bcf5d28097d13db0505e",
        "firstName" : "JohnDemo",
        "lastName" : "DoeCoach18"},
    "modifiedDate" :1348220503568,
    "1332216000000modifiedBy",:
   "objectStatus" : "ACTIVE",   {"courseNameid" : "MTH-100"f02058a4-76e5-4d06-97d2-97d13db0505e",

 "courseTitle" : "Introduction to Math",   "emailCCfirstName" : "john.smith@university.eduDemo",
        "campusIdlastName" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c","Coach18"},
    "earlyAlertReasonIdsobjectStatus" : 
:"ACTIVE",
    [{"idcourseName" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},
 "ENG055",
    {"idcourseTitle" : "216a272f-a457-447e-9bc2-72ee5436a8b1"}],"College ReadingI",
    "earlyAlertReasonOtherDescriptioncourseTermCode" : null,"FA12",
    "earlyAlertSuggestionIdsemailCC" : 
null,
    [{"idcampusId" : "b04b0b520a640a2a-c0e8409d-4cc51271-83ba8140-5252910f012ad10a51770117"},

     {"idearlyAlertReasonOtherDescription":null,
: "d0719473-a17a-44e5-8d63-541870b9983e"}],   "earlyAlertSuggestionOtherDescription" : null,
    "comment" : "StudentDo isto strugglinglack inof MTHattendance classand andlow frequentlytest sleeps"scores, he  "closedDate" : "1332216000000",should consider withdrawing from this class.",
    "closedByIdpersonId" : "91f46e39284c2248-cea887cd-422b342e-b2150c77-00f6bcf5d280d36444ea3b9b"},
  {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995"closedDate":null,
    "createdByclosedById":null,
    "closedByName":null,
    "noOfResponses":1,
    "earlyAlertReasonIds":
        [{"id" : "91f46e39b2d112b8-cea85056-422ba51a-b2158067-00f6bcf5d2801fda2849c3e5",
      "firstName" : "JohncreatedDate":1336003200000,
        "lastNamecreatedBy" :
"Doe"},   "createdDate" : "1332216000000",
  "modifiedBy" : 
     {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
        "firstName" : "JohnSystem",
        "lastName" : "DoeAdministrator"},
    "modifiedDate":1336003200000,
: "1332216000000",   "objectStatusmodifiedBy" :
"ACTIVE",   "courseName" : "ENGL-100",   {"courseTitleid" : "Introduction to English","58ba5ee3-734e-4ae9-b9c5-943774b4de41","
   "emailCC" : "john.smith@university.edu",   "campusIdfirstName" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c"System",
  "earlyAlertReasonIds" :       [{"id" : "839aee41-c882-482d-ba1c-695eae44976a"lastName":"Administrator"},
 
    {"idobjectStatus" : "49300166-ff8a-4707-8c07-9c22d2f2e6d1"}],"ACTIVE",
    "earlyAlertReasonOtherDescriptionname" :"Excessive nullAbsences",
    "earlyAlertSuggestionIdsdescription" : "Excessive Absences",
    [{"idsortOrder" :2}],
"ecd3fd47-90e4-43de-87b6-6e28d4f09455"},    "earlyAlertSuggestionIds":
      [{"id" : "dc35dd0ab2d111ed-5d215056-4190a51a-87b28046-858bb5b505c95291453e8720"}],
    "earlyAlertSuggestionOtherDescriptioncreatedDate":1336003200000,
: null,   "commentcreatedBy" :
null,   "closedDate" : null,   {"closedByIdid" : null}]

Get an Early Alert

GET /ssp/api/1/person/{id}/earlyAlert/{id}

Returns

EarlyAlert

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b:"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdBy" :      {"idfirstName" : "91f46e39-cea8-422b-b215-00f6bcf5d280","System",
        "firstNamelastName" : "JohnAdministrator"},

    "lastNamemodifiedDate" :1336003200000,
"Doe"},  "createdDate" : "1332216000000modifiedBy",:
 "modifiedBy" :      {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
        "firstName" : "JohnSystem",
        "lastName" : "DoeAdministrator"},
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
    "courseNamename" : "MTH-100Withdraw",
    "courseTitledescription" : "Introduction to Math",
  "emailCC" : "john.smith@university.edu",sortOrder":8}],
    "campusIdsendEmailToStudent":false}
 : "3435c2f3-b3c9-4cdc-b35f-2f492557999c ]
}

Get an Early Alert

GET /ssp/api/1/person/{id}/earlyAlert/{id}

Security

PERSON_EARLY_ALERT_READ

Returns

EarlyAlert

Code Block

{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
 "earlyAlertReasonIds" :      [{"id" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},"createdDate":1347964903568,
    "createdBy":
        {"id" : "216a272ff02058a4-a45776e5-447e4d06-9bc297d2-72ee5436a8b197d13db0505e"}],
    "earlyAlertReasonOtherDescription" : null,  "earlyAlertSuggestionIdsfirstName" : "Demo",
    [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a  "lastName":"Coach18"},
     {"idmodifiedDate" : "d0719473-a17a-44e5-8d63-541870b9983e"}],
 "earlyAlertSuggestionOtherDescription" : null,:1348220503568,
    "commentmodifiedBy" : "Student is
struggling in MTH class and frequently sleeps",  {"closedDateid" : "1332216000000",
 "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}

Create an Early Alert

POST /ssp/api/1/person/{id}/earlyAlert

The {id} in the URL for Early Alert creation can either be an existing Person ID in UUID syntax, or it can be the school's legacy School ID (the school-assigned identifier for the student) for an existing Person.

Sample Post

Code Block

{"courseName" : "MTH-101",
 "courseTitle" : "Concepts of Math",
 "emailCC" : "john.smith@university.edu",
 "campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
 "earlyAlertReasonIds" : 
    [{"id" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},
     {"id" : "216a272f-a457-447e-9bc2-72ee5436a8b1"}],
 "earlyAlertReasonOtherDescription" : null,
 "earlyAlertSuggestionIds" : 
    [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "objectStatus":"ACTIVE",
    "courseName":"ENG055",
    "courseTitle":"College ReadingI",
    "courseTermCode":"FA12",
    "emailCC":null,
    "campusId":"0a640a2a-409d-1271-8140-d10a51770117",
    "earlyAlertReasonOtherDescription":null,
    "earlyAlertSuggestionOtherDescription":null,
    "comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
    "personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
    "closedDate":null,
    "closedById":null,
    "closedByName":null,
    "noOfResponses":1,
    "earlyAlertReasonIds":
        [{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
        "createdDate":1336003200000,
        "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
        firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Excessive Absences",
    "description":"Excessive Absences",
    "sortOrder":2}],
    "earlyAlertSuggestionIds":
    [{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
    "createdDate":1336003200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Withdraw",
    "description":"",
    "sortOrder":8}],
    "sendEmailToStudent":false}
}

Create an Early Alert

POST /ssp/api/1/person/{id}/earlyAlert

The {id} in the URL for Early Alert creation can either be an existing Person ID in UUID syntax, or it can be the school's legacy School ID (the school-assigned identifier for the student) for an existing Person.

Security

PERSON_EARLY_ALERT_WRITE

Sample Post

Code Block

{"courseName" : "MTH-101",
 "courseTitle" : "Concepts of Math",
 "courseTermCode" : "FA12",
 "emailCC" : "john.smith@university.edu",
 "campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
 "earlyAlertReasonId" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7",
 "earlyAlertReasonOtherDescription" : null,
 "earlyAlertSuggestionIds" : 
    [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},
     {"id" : "d0719473-a17a-44e5-8d63-541870b9983e"}],
 "earlyAlertSuggestionOtherDescription" : null,
 "personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",
 "comment" : "Student is often late to class and isn't prepared.",
 "sendEmailToStudent" : true}

Returns

EarlyAlert

Code Block

{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
        "createdDate":1347964903568,
    "createdBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "modifiedDate":1348220503568,
    "modifiedBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "objectStatus":"ACTIVE",
    "courseName":"ENG055",
    "courseTitle":"College ReadingI",
    "courseTermCode":"FA12",
    "emailCC":null,
    "campusId":"0a640a2a-409d-1271-8140-d10a51770117",
    "earlyAlertReasonOtherDescription":null,
    "earlyAlertSuggestionOtherDescription":null,
    "comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
    "personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
    "closedDate":null,
    "closedById":null,
    "closedByName":null,
    "noOfResponses":1,
    "earlyAlertReasonIds":
        [{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
        "createdDate":1336003200000,
        "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
        firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Excessive Absences",
    "description":"Excessive Absences",
    "sortOrder":2}],
    "earlyAlertSuggestionIds":
    [{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
    "createdDate":1336003200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Withdraw",
    "description":"",
    "sortOrder":8}],
    "sendEmailToStudent":false}
}

Save an Early Alert

PUT /ssp/api/1/person/{id}/earlyAlert/{id}

Security

PERSON_EARLY_ALERT_WRITE

Sample Post

Code Block

{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
        "createdDate":1347964903568,
    "createdBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "modifiedDate":1348220503568,
    "modifiedBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "objectStatus":"ACTIVE",
    "courseName":"ENG055",
    "courseTitle":"College ReadingI",
    "courseTermCode":"FA12",
    "emailCC":null,
    "campusId":"0a640a2a-409d-1271-8140-d10a51770117",
    "earlyAlertReasonOtherDescription":null,
    "earlyAlertSuggestionOtherDescription":null,
    "comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
    "personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
    "closedDate":null,
    "closedById":null,
    "closedByName":null,
    "noOfResponses":1,
    "earlyAlertReasonIds":
        [{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
        "createdDate":1336003200000,
        "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id" : "d071947358ba5ee3-a17a734e-44e54ae9-8d63b9c5-541870b9983e943774b4de41"}],"
 "earlyAlertSuggestionOtherDescription" : null,       firstName"comment:" : System"Student,
is often late to class and isn't prepared.",  "closedDatelastName" : "1332216000000Administrator"},
  "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}

Returns

EarlyAlert

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : "objectStatus":"ACTIVE",
    "name":"Excessive Absences",
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"description":"Excessive Absences",
    "sortOrder":2}],
    "earlyAlertSuggestionIds":
    [{"firstNameid" : "John"b2d111ed-5056-a51a-8046-5291453e8720",

    "lastNamecreatedDate" :1336003200000,
"Doe"},  "createdDate" : "1332216000000createdBy",:
 "modifiedBy" :      {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
        "firstName" : "JohnSystem",

    "lastName" : "Doe"},  "modifiedDatelastName" : "1332216000000Administrator"},
  "objectStatus" : "ACTIVEmodifiedDate":1336003200000,
 "courseName" : "MTH-101",  "courseTitlemodifiedBy" :
"Concepts of Math",  "emailCC" : "john.smith@university.edu",  {"campusIdid" : "3435c2f358ba5ee3-b3c9734e-4cdc4ae9-b35fb9c5-2f492557999c943774b4de41",
 "earlyAlertReasonIds" :      [{"idfirstName" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},"System",
        {"idlastName" : "216a272f-a457-447e-9bc2-72ee5436a8b1"Administrator"}],

"earlyAlertReasonOtherDescription" : null,  "earlyAlertSuggestionIdsobjectStatus" : "ACTIVE",
    [{"idname" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"}:"Withdraw",
     {"id" : "d0719473-a17a-44e5-8d63-541870b9983e""description":"",
    "sortOrder":8}],
    "earlyAlertSuggestionOtherDescriptionsendEmailToStudent" : null,
 "comment" : "Student is often late to class and isn't prepared.",
 "closedDate" : "1332216000000",
 "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}

Save an Early Alert

PUT /ssp/api/1/person/{id}/earlyAlert/{id}

Sample Post

Code Block
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "createdBy" false} }

Returns

EarlyAlert

Code Block

{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
        "createdDate":1347964903568,
    "createdBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "modifiedDate":1348220503568,
    "modifiedBy":
        {"id" : "91f46e39f02058a4-cea876e5-422b4d06-b21597d2-00f6bcf5d28097d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "objectStatus":"JohnACTIVE",

    "lastNamecourseName" : "DoeENG055"},
 "createdDate" : "1332216000000",  "modifiedBycourseTitle" :"College ReadingI",
    {"idcourseTermCode" : "91f46e39-cea8-422b-b215-00f6bcf5d280"FA12",

    "firstNameemailCC" : "John"null,

    "lastNamecampusId" : "Doe"},
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "courseName" : "MTH-100",
 "courseTitle" : "Introduction to Math",
 "emailCC" : "john.smith@university.edu",
 "campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
 "earlyAlertReasonIds" : 
    [{"id" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},
     {"id" : "216a272f-a457-447e-9bc2-72ee5436a8b1"}],
 "earlyAlertReasonOtherDescription" : null,
 "earlyAlertSuggestionIds" :"0a640a2a-409d-1271-8140-d10a51770117",
    "earlyAlertReasonOtherDescription":null,
    "earlyAlertSuggestionOtherDescription":null,
    "comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
    "personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
    "closedDate":null,
    "closedById":null,
    "closedByName":null,
    "noOfResponses":1,
    "earlyAlertReasonIds":
        [{"id" : "b04b0b52b2d112b8-c0e85056-4cc5a51a-83ba8067-5252910f012a1fda2849c3e5"},
        {"idcreatedDate":1336003200000,
 : "d0719473-a17a-44e5-8d63-541870b9983e"}],  "earlyAlertSuggestionOtherDescription" : null,  "commentcreatedBy" :
"Student is struggling in MTH class and frequently sleeps", {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "closedDatefirstName" : "1332216000000System",
      "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}

Returns

EarlyAlert

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" :lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41","
        "firstName" : "John",System",
        "lastName" : "DoeAdministrator"},
    "createdDateobjectStatus" : "1332216000000ACTIVE",
    "modifiedByname" :"Excessive Absences",
    {"iddescription" :"Excessive "91f46e39-cea8-422b-b215-00f6bcf5d280",
Absences",
    "firstNamesortOrder" : "John",
:2}],
    "lastNameearlyAlertSuggestionIds":
 : "Doe"},  [{"modifiedDateid" : "1332216000000"b2d111ed-5056-a51a-8046-5291453e8720",
 "objectStatus"  : "ACTIVEcreatedDate":1336003200000,
 "courseName" : "MTH-100",
 "courseTitlecreatedBy" :
"Introduction to Math",  "emailCC" : "john.smith@university.edu",  {"campusIdid" : "3435c2f358ba5ee3-b3c9734e-4cdc4ae9-b35fb9c5-2f492557999c943774b4de41",
 "earlyAlertReasonIds" :      [{"idfirstName" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},"System",
        {"idlastName" : "216a272f-a457-447e-9bc2-72ee5436a8b1"Administrator"}],
    "earlyAlertReasonOtherDescription" : null,
 "earlyAlertSuggestionIds" :modifiedDate":1336003200000,
    "modifiedBy":
        [{"id" : "b04b0b5258ba5ee3-c0e8734e-4cc54ae9-83bab9c5-5252910f012a943774b4de41"},
        {"id" : "d0719473-a17a-44e5-8d63-541870b9983e"}],
 "earlyAlertSuggestionOtherDescription" : null,
 "comment" : "Student is struggling in MTH class and frequently sleeps",
 "closedDate" : "1332216000000",
 "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280""firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Withdraw",
    "description":"",
    "sortOrder":8}],
    "sendEmailToStudent":false}
}

Delete an Early Alert

DELETE /ssp/api/1/person/{id}/earlyAlert/{id}

Security

PERSON_EARLY_ALERT_DELETE

Returns

Code Block
{"success" : "true"}

...

Versions Compared

Old Version 11

New Version Current

Key

Get an Early Alert

Get an Early Alert

Create an Early Alert

Create an Early Alert

Save an Early Alert

Save an Early Alert

Delete an Early Alert