Page Comparison

...

status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

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"},
      "createdDatemodifiedDate" : "1332216000000",
 1348220503568,
    "modifiedBy" : 

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

     "modifiedDateobjectStatus" : "1332216000000ACTIVE",

     "objectStatuscourseName" : "ACTIVEENG055",
 
    "courseNamecourseTitle" :"College ReadingI"MTH-100",,
      "courseTitlecourseTermCode" : "Introduction to MathFA12",
      "emailCC" : "john.smith@university.edu",
 :null,
    "campusId" : "3435c2f30a640a2a-b3c9409d-4cdc1271-b35f8140-2f492557999cd10a51770117",
      "earlyAlertReasonIdsearlyAlertReasonOtherDescription" : null,
    "earlyAlertSuggestionOtherDescription":null,
    [{"idcomment" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},
     "Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
    {"idpersonId" : "216a272f284c2248-a45787cd-447e342e-9bc20c77-72ee5436a8b1d36444ea3b9b"}],
 
    "earlyAlertReasonOtherDescriptionclosedDate" : null,
 
    "earlyAlertSuggestionIdsclosedById" : null,
    "closedByName":null,
    [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},noOfResponses":1,
    "earlyAlertReasonIds":
          [{"id" : "d0719473b2d112b8-a17a5056-44e5a51a-8d638067-541870b9983e1fda2849c3e5"}],
        "earlyAlertSuggestionOtherDescriptioncreatedDate":1336003200000,
: null,       "commentcreatedBy" :
"Student is struggling in MTH class and frequently sleeps", {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "closedDatefirstName" : "1332216000000System",
        "closedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Administrator"},

    {"idmodifiedDate" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 :1336003200000,
    "createdBymodifiedBy" :
          {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
"
         "firstName" : "JohnSystem",
 
        "lastName" : "DoeAdministrator"},
 
    "createdDateobjectStatus" : "1332216000000ACTIVE",
      "modifiedByname" :"Excessive Absences",
    "description":"Excessive Absences",
    {"idsortOrder":2}],
: "91f46e39-cea8-422b-b215-00f6bcf5d280",   "earlyAlertSuggestionIds":
       "firstName" : "John[{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
     "createdDate":1336003200000,
    "lastNamecreatedBy":
: "Doe"},       {"modifiedDateid" : "1332216000000"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "objectStatusfirstName" : "ACTIVESystem",
        "courseNamelastName" : "ENGL-100Administrator"},
 
    "courseTitlemodifiedDate" : "Introduction to English",
 :1336003200000,
    "emailCCmodifiedBy":
: "john.smith@university.edu",       {"campusIdid" : "3435c2f358ba5ee3-b3c9734e-4cdc4ae9-b35fb9c5-2f492557999c943774b4de41",
        "earlyAlertReasonIdsfirstName" :"System",
          [{"idlastName" : "839aee41-c882-482d-ba1c-695eae44976a"Administrator"},
     "objectStatus":"ACTIVE",
    {"idname" : "49300166-ff8a-4707-8c07-9c22d2f2e6d1"}],
"Withdraw",
     "earlyAlertReasonOtherDescriptiondescription" : null"",
 
    "earlyAlertSuggestionIdssortOrder" : 
 :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" : "ecd3fd4784ace006-90e41a36-43de4acc-87b683a7-6e28d4f094552d87abfcf3c2"},
          {"idcreatedDate" : "dc35dd0a-5d21-4190-87b2-858bb5b505c9"}],
 :1347964903568,
    "earlyAlertSuggestionOtherDescriptioncreatedBy":
: null,       "comment" : null,{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "closedDatefirstName":"Demo",
: null,       "closedByIdlastName" : null}]
}

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" :"Coach18"},
    "modifiedDate":1348220503568,
    "modifiedBy":
        {"id" : "91f46e39f02058a4-cea876e5-422b4d06-b21597d2-00f6bcf5d28097d13db0505e",
        "firstName" : "JohnDemo",
        "lastName" : "DoeCoach18"},
    "createdDateobjectStatus" : "1332216000000ACTIVE",
    "modifiedBycourseName" : "ENG055",
    {"idcourseTitle" :"College "91f46e39-cea8-422b-b215-00f6bcf5d280",ReadingI",
      "firstNamecourseTermCode" : "JohnFA12",
     "lastNameemailCC":null,
 : "Doe"},  "modifiedDatecampusId" : "1332216000000"0a640a2a-409d-1271-8140-d10a51770117",
  "objectStatus" : "ACTIVEearlyAlertReasonOtherDescription":null,
  "courseName" : "MTH-100earlyAlertSuggestionOtherDescription":null,
  "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" :   "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"},
     {"id"  : "d0719473-a17a-44e5-8d63-541870b9983e"}],
 "earlyAlertSuggestionOtherDescription" : null,createdDate":1336003200000,
        "commentcreatedBy" :
"Student is struggling in MTH class and frequently sleeps",
 "closedDate" : "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.

Security

PERSON_EARLY_ALERT_WRITE

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":"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" : "216a272f58ba5ee3-a457734e-447e4ae9-9bc2b9c5-72ee5436a8b1943774b4de41"}],
 "earlyAlertReasonOtherDescription" : null       "firstName":"System",
 "earlyAlertSuggestionIds" :      [{"idlastName" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"Administrator"},
     {"idobjectStatus" : "d0719473-a17a-44e5-8d63-541870b9983e"}],
 "earlyAlertSuggestionOtherDescription" : null,
 "comment" : "Student is often late to class and isn't prepared.","ACTIVE",
    "name":"Withdraw",
    "description":"",
    "sortOrder":8}],
    "sendEmailToStudent" :false}
true}

Returns

EarlyAlert

...

Code Block

{"id" : "91f46e3984ace006-cea81a36-422b4acc-b21583a7-00f6bcf5d2802d87abfcf3c2",
      "firstName" : "JohncreatedDate":1347964903568,

    "lastName" : "Doe"},
 "createdDate" : "1332216000000",
 "modifiedBy" :createdBy":
        {"id" : "91f46e39f02058a4-cea876e5-422b4d06-b21597d2-00f6bcf5d28097d13db0505e",
        "firstName" : "JohnDemo",
        "lastName" : "DoeCoach18"},
 "modifiedDate" : "1332216000000",  "objectStatusmodifiedDate" : "ACTIVE"1348220503568,

"courseName" : "MTH-101",  "courseTitlemodifiedBy" :
"Concepts of Math",  "emailCC" : "john.smith@university.edu",  {"campusIdid" : "3435c2f3f02058a4-b3c976e5-4cdc4d06-b35f97d2-2f492557999c97d13db0505e",
 "earlyAlertReasonIds" :      [{"idfirstName" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},"Demo",
      {  "idlastName" : "216a272f-a457-447e-9bc2-72ee5436a8b1"Coach18"}],
    "objectStatus":"earlyAlertReasonOtherDescriptionACTIVE",
 : null,  "earlyAlertSuggestionIdscourseName" : "ENG055",
    [{"idcourseTitle" :"College "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},
ReadingI",
    {"idcourseTermCode" : "d0719473-a17a-44e5-8d63-541870b9983e"}],"FA12",
    "earlyAlertSuggestionOtherDescriptionemailCC" : null,
    "campusId"comment" : "Student is often late to class and isn't prepared."}

Save an Early Alert

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

Security

PERSON_EARLY_ALERT_WRITE

Sample Post

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280:"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",
     "firstNameclosedDate" : "John"null,

    "lastNameclosedById" : "Doe"}null,
 "createdDate" : "1332216000000",
 "modifiedByclosedByName" :null,
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280""noOfResponses":1,
     "firstNameearlyAlertReasonIds":
 : "John",      [{"lastNameid" : "Doe"},
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "courseName" : "MTH-100",
 "courseTitle" : "Introduction to Math",
 "emailCC" : "john.smith@university.edu",
 "campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
 "earlyAlertReasonIds" :"b2d112b8-5056-a51a-8067-1fda2849c3e5",
        "createdDate":1336003200000,
        "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        [{"idfirstName" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},"System",
      {"id" : "216a272f-a457-447e-9bc2-72ee5436a8b1"lastName":"Administrator"}],
 "earlyAlertReasonOtherDescription" : null,  "earlyAlertSuggestionIdsmodifiedDate" : 1336003200000,
    [{"idmodifiedBy":
 : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},      {"id" : "d071947358ba5ee3-a17a734e-44e5-8d63-541870b9983e"}],
 "earlyAlertSuggestionOtherDescription" : null,
 "comment" : "Student is struggling in MTH class and frequently sleeps",
 "closedDate" : "1332216000000",
 "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}

Returns

EarlyAlert

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 4ae9-b9c5-943774b4de41","
        firstName":"System",
        "lastName":"Administrator"},
    {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"ACTIVE",

    "firstNamename" :"Excessive Absences"John",
     "lastNamedescription" :"Excessive "DoeAbsences"},
  "createdDate" : "1332216000000sortOrder":2}],
    "modifiedByearlyAlertSuggestionIds" :
     [{"id" : "91f46e39b2d111ed-cea85056-422ba51a-b2158046-00f6bcf5d2805291453e8720",

    "firstNamecreatedDate" : "John"1336003200000,

    "lastNamecreatedBy" : "Doe"},

"modifiedDate" : "1332216000000",  "objectStatus" : "ACTIVE",  {"courseNameid" : "MTH-100"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
  "courseTitle" : "Introduction to Math",  "emailCCfirstName" : "john.smith@university.eduSystem",
 "campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
 "earlyAlertReasonIds" :        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    [{"idmodifiedBy":
: "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},        {"id" : "216a272f58ba5ee3-a457734e-447e4ae9-9bc2b9c5-72ee5436a8b1943774b4de41"}],
 "earlyAlertReasonOtherDescription" : null,
 "earlyAlertSuggestionIds" :      [{"idfirstName" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},"System",
       { "idlastName" : "d0719473-a17a-44e5-8d63-541870b9983e"Administrator"}],
 "earlyAlertSuggestionOtherDescription" : null,
 "commentobjectStatus" : "ACTIVE"Student,
is struggling in MTH class and frequently sleeps", "name":"Withdraw",
    "closedDatedescription" : "1332216000000",
    "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"sortOrder":8}],
    "sendEmailToStudent":false}
}

Delete an Early Alert

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

...

Versions Compared

Old Version 17

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