Page Comparison

Get All Early Alerts for a Person

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",

 "createdByIdmessage" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDateresults":1,
: "1332216000000rows",:
    [{"modifiedByIdid" : "91f46e3984ace006-cea81a36-422b4acc-b21583a7-00f6bcf5d2802d87abfcf3c2",
   "modifiedDate" : "1332216000000",   "objectStatuscreatedDate" : "ACTIVE"1347964903568,
  "courseName" : "MTH-100createdBy",:
  "courseTitle" : "Introduction to Math",   {"emailCCid" : "john.smith@university.edu","f02058a4-76e5-4d06-97d2-97d13db0505e",
   "campusId" : 1,   "firstName":"earlyAlertReasonIdsDemo",
:         [{"idlastName", "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7:"Coach18"},
 
    {"idmodifiedDate":1348220503568,
"216a272f-a457-447e-9bc2-72ee5436a8b1"},    "modifiedBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
       ... "firstName":"Demo",
     ],   "lastName":"earlyAlertReasonOtherDescriptionCoach18"},
: null,   "earlyAlertSuggestionIdsobjectStatus" : "ACTIVE",
     [{"id", "b04b0b52-c0e8-4cc5-83ba-5252910f012a"}"courseName":"ENG055",
      {"id", "d0719473-a17a-44e5-8d63-541870b9983e"}"courseTitle":"College ReadingI",
    "courseTermCode":"FA12",
 ],   "earlyAlertSuggestionOtherDescriptionemailCC" : null,
    "commentcampusId" : "Student is struggling in MTH class and frequently sleeps"},
 {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "objectStatus" : "ACTIVE",
  "courseName" : "ENGL-100",
  "courseTitle" : "Introduction to English",
  "emailCC" : "john.smith@university.edu",
  "campusId" : 1,
  "earlyAlertReasonIds" : 
"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", :"839aee41b2d112b8-c8825056-482da51a-ba1c8067-695eae44976a1fda2849c3e5"},
       {"id", "49300166-ff8a-4707-8c07-9c22d2f2e6d1"},
      ...createdDate":1336003200000,
     ],   "earlyAlertReasonOtherDescriptioncreatedBy" : null,

 "earlyAlertSuggestionIds" :       [{"id" : "ecd3fd4758ba5ee3-90e4734e-43de4ae9-87b6b9c5-6e28d4f09455943774b4de41"},
      {   "idfirstName" : "dc35dd0a-5d21-4190-87b2-858bb5b505c9"}"System",
       ...
 "lastName":"Administrator"},
    ],"modifiedDate":1336003200000,
    "earlyAlertSuggestionOtherDescriptionmodifiedBy" :
null,   "comment" : null},  ...
]

Get an Early Alert

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

Returns

EarlyAlert

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",
 "courseName" : "MTH-100",
 "courseTitle" : "Introduction to Math",
 "emailCC" : "john.smith@university.edu",
 "campusId" : 1,
 "earlyAlertReasonIds" : 
    [{"id", "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},
     {"id", "216a272f-a457-447e-9bc2-72ee5436a8b1"},
     ...
    ],
 "earlyAlertReasonOtherDescription" : null,
 "earlyAlertSuggestionIds" : 
    [{"id", "b04b0b52-c0e8-4cc5-83ba-5252910f012a"}, {"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}
  ]
}

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",
        "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}
}

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":"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", :"d071947358ba5ee3-a17a734e-44e54ae9-8d63b9c5-541870b9983e943774b4de41"},
      ],  "earlyAlertSuggestionOtherDescriptionfirstName" : null,
 "commentSystem" :,
"Student is struggling in MTH class and frequently sleeps"}

Create an Early Alert

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

Sample Post

Code Block

{"courseName" : "MTH-101",
 "courseTitle" : "Concepts of Math",
 "emailCC" : "john.smith@university.edu",
 "campusId" : 1,
 "earlyAlertReasonIds" : 
    [{"id", "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"}"lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Withdraw",
    "description":"",
    "sortOrder":8}],
    "sendEmailToStudent":false}
}

Returns

EarlyAlert

Code Block

{"id", :"216a272f84ace006-a4571a36-447e4acc-9bc283a7-72ee5436a8b12d87abfcf3c2"},
      ...  "createdDate":1347964903568,
  ],  "earlyAlertReasonOtherDescriptioncreatedBy" : null,
 "earlyAlertSuggestionIds" :      [{"id", :"b04b0b52f02058a4-c0e876e5-4cc54d06-83ba97d2-5252910f012a97d13db0505e"},
        {"id"firstName":"Demo", "d0719473-a17a-44e5-8d63-541870b9983e"}
      ],  "lastName"earlyAlertSuggestionOtherDescription" : null,:"Coach18"},
    "commentmodifiedDate":1348220503568,
: "Student is often late"modifiedBy":
to class and isn't prepared."}

Returns

EarlyAlert

Code Block

     {"id" : "6201b18df02058a4-9d1d76e5-48d34d06-82d497d2-092e52ad676b97d13db0505e",
    "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",  "createdDatefirstName" : "1332216000000Demo",
  "modifiedById"  : "91f46e39-cea8-422b-b215-00f6bcf5d280",    "modifiedDatelastName" : "1332216000000Coach18"},
    "objectStatus" : "ACTIVE",
    "courseName" : "MTH-101ENG055",
    "courseTitle" :"College ReadingI"Concepts,
 of Math",  "emailCCcourseTermCode" : "john.smith@university.eduFA12",
 "campusId" : 1,  "earlyAlertReasonIdsemailCC" :null,
     [{"idcampusId", :"e02521fc0a640a2a-53ca409d-4fe61271-8de78140-b2a1fb3d08f7d10a51770117"},
     {"idearlyAlertReasonOtherDescription":null,
 "216a272f-a457-447e-9bc2-72ee5436a8b1"},   "earlyAlertSuggestionOtherDescription":null,
    "comment":"Do to ...lack of attendance and low ]test scores,  "earlyAlertReasonOtherDescription" : null,
 "earlyAlertSuggestionIds" : he should consider withdrawing from this class.",
    [{"idpersonId", :"b04b0b52284c2248-c0e887cd-4cc5342e-83ba0c77-5252910f012ad36444ea3b9b"},

    {"idclosedDate":null,
    "d0719473-a17a-44e5-8d63-541870b9983e"}
 closedById":null,
  ],  "earlyAlertSuggestionOtherDescriptionclosedByName" : null,
    "commentnoOfResponses":1,
: "Student is often late"earlyAlertReasonIds":
to class and isn't prepared."}

Save an Early Alert

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

Sample Post

Code Block

     [{"id" : "6201b18db2d112b8-9d1d5056-48d3a51a-82d48067-092e52ad676b1fda2849c3e5",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "courseName" : "MTH-100",
 "courseTitle" : "Introduction to Math",
 "emailCC" : "john.smith@university.edu",
 "campusId" : 1,
 "earlyAlertReasonIds" : 
    [{"id", "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},      "createdDate":1336003200000,
        "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id", :"216a272f58ba5ee3-a457734e-447e4ae9-9bc2b9c5-72ee5436a8b1943774b4de41"},"
     ...     ],
 "earlyAlertReasonOtherDescription" : nullfirstName":"System",
 "earlyAlertSuggestionIds" :      [{"idlastName", "b04b0b52-c0e8-4cc5-83ba-5252910f012a:"Administrator"},
     {"id"objectStatus":"ACTIVE",
"d0719473-a17a-44e5-8d63-541870b9983e"}     ]"name":"Excessive Absences",
 "earlyAlertSuggestionOtherDescription" : null,  "commentdescription" :"Excessive Absences"Student,
  is struggling in MTH class and frequently sleeps"}

Returns

EarlyAlert

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "sortOrder":2}],
    "earlyAlertSuggestionIds":
    [{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
    "createdDate" ::1336003200000,
    "1332216000000",createdBy":
        {"modifiedByIdid" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
 "modifiedDate" : "1332216000000",  "objectStatus" : "ACTIVE",  "courseNamefirstName" : "MTH-100System",
  "courseTitle" : "Introduction to Math",  "emailCClastName" : "john.smith@university.eduAdministrator"},
 "campusId" : 1,  "earlyAlertReasonIdsmodifiedDate" : 1336003200000,
    [{"idmodifiedBy", "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},:
        {"id", :"216a272f58ba5ee3-a457734e-447e4ae9-9bc2b9c5-72ee5436a8b1943774b4de41"},
     ...   "firstName":"System",
        ],"lastName":"Administrator"},
    "objectStatus"earlyAlertReasonOtherDescription:"ACTIVE",
 : null,  "earlyAlertSuggestionIdsname" : "Withdraw",
    [{"iddescription", "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},
:"",
    {"idsortOrder", "d0719473-a17a-44e5-8d63-541870b9983e"}
 :8}],
  ],  "earlyAlertSuggestionOtherDescriptionsendEmailToStudent" :false}
null,}

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 3

New Version Current

Key

Get All Early Alerts for a Person

Get an Early Alert

Get an Early Alert

Create an Early Alert

Save an Early Alert

Create an Early Alert

Save an Early Alert

Delete an Early Alert