Versions Compared

Key

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

...

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", "d0719473-a17a-44e5-8d63-541870b9983e"}
     ],
  "earlyAlertSuggestionOtherDescription" : null,
  "comment" : "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" : 
     [{"id", "839aee41-c882-482d-ba1c-695eae44976a"},
      {"id", "49300166-ff8a-4707-8c07-9c22d2f2e6d1"},
      ...
     ],
  "earlyAlertReasonOtherDescription" : null,
  "earlyAlertSuggestionIds" : 
     [{"id" : "ecd3fd47-90e4-43de-87b6-6e28d4f09455"},
      {"id" : "dc35dd0a-5d21-4190-87b2-858bb5b505c9"}
      ...
     ],
  "earlyAlertSuggestionOtherDescription" : null,
  "comment" : null},
 ...
]

Get an Early Alert

...

GET /ssp/api/1/person/reference{id}/earlyAlertReasonearlyAlert/{id}

Returns

EarlyAlertReasonEarlyAlert

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",
  "name" : "Academic Concern",
 "description" : "Academic concern",
 "sortOrder" : 1"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", "d0719473-a17a-44e5-8d63-541870b9983e"}
    ],
 "earlyAlertSuggestionOtherDescription" : null,
 "comment" : "Student is struggling in MTH class and frequently sleeps"}

 

Create an Early Alert

...

POST /ssp/api/1/person/reference{id}/earlyAlertReasonearlyAlert

Sample Post

Code Block
{"description" : "Low test scores.",
 "name" : "Low Test Scores"courseName" : "MTH-101",
 "courseTitle" : "Concepts of 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", "d0719473-a17a-44e5-8d63-541870b9983e"}
    ],
 "earlyAlertSuggestionOtherDescription" : null,
 "comment" : "Student is often late to class and isn't prepared."}

Returns

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",
 "courseName" : "MTH-101",
 "courseTitle" : "nameConcepts of Math",
 "emailCC" : "Low Test Scores""john.smith@university.edu",
 "campusId" : 1,
 "descriptionearlyAlertReasonIds" : "Low test scores.",
 "sortOrder" : 3 
    [{"id", "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},
     {"id", "216a272f-a457-447e-9bc2-72ee5436a8b1"},
     ...
    ],
 "earlyAlertReasonOtherDescription" : null,
 "earlyAlertSuggestionIds" : 
    [{"id", "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},
     {"id", "d0719473-a17a-44e5-8d63-541870b9983e"}
    ],
 "earlyAlertSuggestionOtherDescription" : null,
 "comment" : "Student is often late to class and isn't prepared."}

 

Save an Early Alert

...

PUT /ssp/api/1/person/reference{id}/earlyAlertReasonearlyAlert/{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",
 "courseName" : "MTH-100",
 "courseTitle" : "Introduction to Math",
 "emailCC" : "john.smith@university.edu",
 "namecampusId" : 1,
 "earlyAlertReasonIds" : 
    [{"id", "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},
     "Academic Concern"{"id", "216a272f-a457-447e-9bc2-72ee5436a8b1"},
     ...
    ],
 "earlyAlertReasonOtherDescription" : null,
 "descriptionearlyAlertSuggestionIds" : "Academic concern" 
    [{"id", "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},
     {"id", "d0719473-a17a-44e5-8d63-541870b9983e"}
    ],
 "earlyAlertSuggestionOtherDescription" : null,
 "sortOrdercomment" : 1 "Student is struggling in MTH class and frequently sleeps"}

Returns

EarlyAlertReasonEarlyAlert

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",
 "namecourseTitle" : "Introduction to Math",
 "Academic ConcernemailCC" : "john.smith@university.edu",
 "description" : "Academic concern"campusId" : 1,
 "earlyAlertReasonIds" : 
    [{"id", "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"},
     {"id", "216a272f-a457-447e-9bc2-72ee5436a8b1"},
     ...
    ],
 "earlyAlertReasonOtherDescription" : null,
 "sortOrderearlyAlertSuggestionIds" : 1} 
    [{"id", "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},
     {"id", "d0719473-a17a-44e5-8d63-541870b9983e"}
    ],
 "earlyAlertSuggestionOtherDescription" : null,

 

Delete an Early Alert

...

DELETE /ssp/api/1/reference/earlyAlertReasonperson/{id}/earlyAlert/{id}

Returns

Code Block
{"success" : "true"}

...