Page Comparison

...

Returns

Code Block

{"success" : "true",
 "resultsmessage" : "","100results":1,
 "rows" : 
    [{"id" : "6201b18d84ace006-9d1d1a36-48d34acc-82d483a7-092e52ad676b2d87abfcf3c2",
        "createdBycreatedDate":1347964903568,
:    "createdBy":
        {"id" : "91f46e39f02058a4-cea876e5-422b4d06-b21597d2-00f6bcf5d28097d13db0505e",
 
        "firstName" : "JohnDemo",
 
        "lastName" : "DoeCoach18"},
      "createdDate" : "1332216000000",
 "modifiedDate":1348220503568,
    "modifiedBy" : 

        {"id" : "91f46e39f02058a4-cea876e5-422b4d06-b21597d2-00f6bcf5d28097d13db0505e",
 
        "firstName" : "JohnDemo",
          "lastName" : "DoeCoach18"},

     "modifiedDateobjectStatus" : "1332216000000ACTIVE",

     "objectStatuscourseName" : "ACTIVEENG055",
 
    "courseNamecourseTitle" :"College ReadingI"MTH-100",,
      "courseTitle" : "Introduction to Math",
      "courseTermCode" : "FA12",

     "emailCC" : "john.smith@university.edu":null,
      "campusId" : "3435c2f30a640a2a-b3c9409d-4cdc1271-b35f8140-2f492557999cd10a51770117",
    "earlyAlertReasonOtherDescription":null,
    "earlyAlertReasonIdearlyAlertSuggestionOtherDescription" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7":null,
      "comment"earlyAlertReasonOtherDescription:"Do :to null,lack of attendance and low test scores, "earlyAlertSuggestionIds" : 
    he should consider withdrawing from this class.",
    [{"idpersonId" : "b04b0b52284c2248-c0e887cd-4cc5342e-83ba0c77-5252910f012ad36444ea3b9b"},
    "closedDate":null,
     {"idclosedById" : "d0719473-a17a-44e5-8d63-541870b9983e"}],
 :null,
    "earlyAlertSuggestionOtherDescriptionclosedByName" : null,
 
    "commentnoOfResponses" :1,
"Student is struggling in MTH"earlyAlertReasonIds":
class and frequently sleeps",       [{"personIdid":"fa8d6aebb2d112b8-7de85056-11e2a51a-b8658067-406c8f22c3ebc1fda2849c3e5",
      "closedDate"  : "1332216000000createdDate":1336003200000,
      "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"},
 createdBy":
    "closedByName" : "Coach Smith"    {"id" : "c57f11e158ba5ee3-7ef2734e-49894ae9-9ac2b9c5-7b0690563995943774b4de41",
        "createdByfirstName" :"System",
          {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280""lastName":"Administrator"},
     "modifiedDate":1336003200000,
    "firstNamemodifiedBy" : "John",
          {"lastNameid" : "Doe"},"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
        "createdDatefirstName" : "1332216000000System",
        "modifiedBylastName" : 
:"Administrator"},
        {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"ACTIVE",
    "name":"Excessive Absences",
    "firstNamedescription" :"Excessive Absences"John",
    
     "lastNamesortOrder" : "Doe"2}],
 
    "modifiedDateearlyAlertSuggestionIds":
 : "1332216000000",
   [{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
    "createdDate":1336003200000,
    "objectStatuscreatedBy":
: "ACTIVE",       {"courseNameid" : "ENGL-100"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "courseTitlefirstName" : "Introduction to EnglishSystem",
      "courseTermCode" : "FA12",
      "emailCC" : "john.smith@university.edu",
 lastName":"Administrator"},
    "campusIdmodifiedDate" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
:1336003200000,
     "earlyAlertReasonIdsmodifiedBy" : 

        [{"id" : "839aee4158ba5ee3-c882734e-482d4ae9-ba1cb9c5-695eae44976a943774b4de41"},
 
        {"idfirstName" : "49300166-ff8a-4707-8c07-9c22d2f2e6d1"}],"System",
        "earlyAlertReasonOtherDescriptionlastName" : null,
 :"Administrator"},
    "earlyAlertSuggestionIdsobjectStatus" : "ACTIVE",
    "name":"Withdraw",
    [{"iddescription" : "ecd3fd47-90e4-43de-87b6-6e28d4f09455"},
     
    {"idsortOrder" : "dc35dd0a-5d21-4190-87b2-858bb5b505c9":8}],
      "earlyAlertSuggestionOtherDescriptionsendEmailToStudent" :false}
null,       "comment" : null,
      "personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc]
}

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", "closedDatecreatedDate" : null1347964903568, "closedByIdcreatedBy": : null} {"closedByNameid" : "Coach Smith",}] }

Get an Early Alert

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

Security

PERSON_EARLY_ALERT_READ

Returns

EarlyAlert

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" :"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        {"idlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"Coach18"},
    "firstNamemodifiedDate" : "John"1348220503568,
     "lastNamemodifiedBy" :
"Doe"},  "createdDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39f02058a4-cea876e5-422b4d06-b21597d2-00f6bcf5d28097d13db0505e",
        "firstName" : "JohnDemo",
        "lastName" : "DoeCoach18"},

"modifiedDate" : "1332216000000",  "objectStatus" : "ACTIVE",
    "courseName" : "MTH-100ENG055",
    "courseTitle" :"College ReadingI"Introduction,
 to Math",  "courseTermCode" : "FA12",
    "emailCC":null,
: "john.smith@university.edu",    "campusId" : "3435c2f30a640a2a-b3c9409d-4cdc1271-b35f8140-2f492557999cd10a51770117",
  "earlyAlertReasonId" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"earlyAlertReasonOtherDescription":null,
    "earlyAlertReasonOtherDescriptionearlyAlertSuggestionOtherDescription" : null,
    "earlyAlertSuggestionIdscomment" : "Do to lack of attendance [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},
and low test scores, he should consider withdrawing from this class.",
    {"idpersonId" : "d0719473284c2248-a17a87cd-44e5342e-8d630c77-541870b9983ed36444ea3b9b"}],
    "earlyAlertSuggestionOtherDescriptionclosedDate" : null,
    "commentclosedById" :null,
"Student is struggling in MTH class and frequently sleeps",
 "personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",
 "closedDate" : "1332216000000",
 "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"
 "closedByName" : "Coach Smith",}

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"},  "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" : "d071947358ba5ee3-a17a734e-44e54ae9-8d63b9c5-541870b9983e943774b4de41"}],
 "earlyAlertSuggestionOtherDescription" : null,  "personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",   "commentfirstName" : "System"Student,
is often late to class and isn't prepared.",  "sendEmailToStudentlastName" : true}

Returns

EarlyAlert

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" :"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
        "firstName" : "JohnSystem",

    "lastName" : "Doe"},  "createdDatelastName" : "1332216000000Administrator"},
 "modifiedBy" :      {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"ACTIVE",

    "firstNamename" : "JohnWithdraw",
     "lastNamedescription" : "Doe"},
 "modifiedDate"  : "1332216000000sortOrder":8}],
  "objectStatus" : "ACTIVEsendEmailToStudent",
 "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" ::false}
}

Returns

EarlyAlert

Code Block

{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
        "createdDate":1347964903568,
    "createdBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        [{"idfirstName" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},"Demo",
        {"idlastName" : "d0719473-a17a-44e5-8d63-541870b9983e"Coach18"}],
    "earlyAlertSuggestionOtherDescriptionmodifiedDate":1348220503568,
:  null,  "commentmodifiedBy" : "Student is often
late to class and isn't prepared."
 "personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",}

Save an Early Alert

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

Security

PERSON_EARLY_ALERT_WRITE

Sample Post

Code Block

   {"id" : "6201b18df02058a4-9d1d76e5-48d34d06-82d497d2-092e52ad676b97d13db0505e",
  "createdBy" :      "firstName":"Demo",
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280"lastName":"Coach18"},
    "objectStatus":"ACTIVE",
    "courseName":"ENG055",
     "firstNamecourseTitle" :"College "JohnReadingI",

    "lastNamecourseTermCode" : "DoeFA12"},
  "createdDate" : "1332216000000emailCC":null,
    "modifiedBycampusId" : :"0a640a2a-409d-1271-8140-d10a51770117",
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280"earlyAlertReasonOtherDescription":null,
    "earlyAlertSuggestionOtherDescription":null,
     "comment"firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "courseName" : "MTH-100",
 "courseTitle" : "Introduction to 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"},:"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" : "d071947358ba5ee3-a17a734e-44e54ae9-8d63b9c5-541870b9983e943774b4de41"}],
 "earlyAlertSuggestionOtherDescription" : null,       "commentfirstName" :"System",
"Student is struggling in MTH class and frequently sleeps" "lastName":"Administrator"},
    "personIdmodifiedDate":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",
 "closedDate" : "1332216000000",
 "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"
 "closedByName" : "Coach Smith"}

Returns

EarlyAlert

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
        firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "firstNamename" :"Excessive "JohnAbsences",
     "lastNamedescription" :"Excessive Absences"Doe"},
  "createdDate" : "1332216000000sortOrder":2}],
    "modifiedByearlyAlertSuggestionIds" :
     [{"id" : "91f46e39b2d111ed-cea85056-422ba51a-b2158046-00f6bcf5d2805291453e8720",
     "firstNamecreatedDate" : "John"1336003200000,

    "lastNamecreatedBy":
 : "Doe"},  "modifiedDate" : "1332216000000",  {"objectStatusid" : "ACTIVE",
 "courseName" : "MTH-100",
 "courseTermCode" : "FA12"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
 "courseTitle"  : "Introduction to Math",  "emailCClastName" : "john.smith@university.eduAdministrator"},
  "campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c"modifiedDate":1336003200000,
 "earlyAlertReasonId" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7",
 "earlyAlertReasonOtherDescriptionmodifiedBy" : null,
 "earlyAlertSuggestionIds" :      [{"id" : "b04b0b5258ba5ee3-c0e8734e-4cc54ae9-83bab9c5-5252910f012a943774b4de41"},
        {"idfirstName" : "d0719473-a17a-44e5-8d63-541870b9983e"}],
 "earlyAlertSuggestionOtherDescription" : null,"System",
        "commentlastName" : "Student is struggling in MTH class and frequently sleeps","Administrator"},
    "personIdobjectStatus":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebcACTIVE",
    "closedDatename" : "1332216000000Withdraw",
    "closedByIddescription" : "91f46e39-cea8-422b-b215-00f6bcf5d280"",
    "closedByName" : "Coach Smith"sortOrder":8}],
    "sendEmailToStudent":false}
}

Delete an Early Alert

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

...

Versions Compared

Old Version 20

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