Page Comparison

Get All

...

Responses for an Early Alert

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

Security

PERSON_EARLY_ALERT_RESPONSE_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<EarlyAlertResponse>

Code Block

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "createdBy" : 
         {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "createdDatefirstName" : "1332216000000John",
  "modifiedById        "lastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280",Doe"},
      "modifiedDatecreatedDate" : "1332216000000",
      "modifiedBy" : 
         {"objectStatusid" : "ACTIVE91f46e39-cea8-422b-b215-00f6bcf5d280",
          "courseNamefirstName" : "MTH-100John",
    "courseTitle      "lastName" : "Introduction to Math","Doe"},
      "emailCCmodifiedDate" : "john.smith@university.edu1332216000000",
      "campusIdobjectStatus" : 1"ACTIVE",
      "earlyAlertReasonIdsearlyAlertOutreachIds" : 
         [{"id" : "e02521fc198c1b80-53cafee5-4fe64ece-8de7aefb-b2a1fb3d08f797c23beac116"},
          {"id" : "216a272f3fd7e44d-a457dc33-447e4519-9bc29e93-72ee5436a8b1dc85d24f9074"}],
      "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
      "earlyAlertReasonOtherDescriptionearlyAlertOutcomeOtherDescription" : null,
      "earlyAlertSuggestionIdsearlyAlertReferralIds" :  
         [{"id" : "b04b0b524139a3ba-c0e8b7fa-4cc54ff3-83baab09-5252910f012a43cf3d9de8a6"},
          {"id" : "d071947330a17f21-a17a6aaa-44e549fb-8d638b0b-541870b9983ebd53585ed3ac"}],
  "earlyAlertSuggestionOtherDescription" : null,   "comment" : "Student is struggling in MTH class and frequently sleeps"},Follow-up via Phone.  Appt scheduled."},
     {"id" : "c57f11e16201b18d-7ef29d1d-498948d3-9ac282d4-7b0690563995092e52ad676b",
      "createdBy" : 
    "createdById     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "createdDatefirstName" : "1332216000000John",
          "modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Doe"},
      "modifiedDatecreatedDate" : "1332216000000",
  "objectStatus    "modifiedBy" : 
         {"id" : "ACTIVE",91f46e39-cea8-422b-b215-00f6bcf5d280",
          "courseNamefirstName" : "ENGL-100John",
          "courseTitlelastName" : "Introduction to English",Doe"},
      "emailCCmodifiedDate" : "john.smith@university.edu1332216000000",
      "campusIdobjectStatus" : 1"ACTIVE",
      "earlyAlertReasonIdsearlyAlertOutreachIds" : 
         [{"id" : "839aee4188b9bd08-c8825814-482d44d4-ba1c8ff2-695eae44976a1667597f8bba"},
          {"id" : "493001666373d1ef-ff8ad2a2-470748a7-8c07aa78-9c22d2f2e6d1c0b4a29da3ef"}],
      "earlyAlertOutcomeId" : "00c42b84-88fe-4bc9-8cef-723cd6a26c65",
      "earlyAlertReasonOtherDescriptionearlyAlertOutcomeOtherDescription" : null,"Student stopped by.",
      "earlyAlertSuggestionIdsearlyAlertReferralIds" :  
         [{"id" : "ecd3fd47b2f52c40-90e482dd-43de4b09-87b69ec0-6e28d4f0945506f98c0c54c9"},
           {"id" : "dc35dd0a6ef6aca6-5d214fd6-41904bd2-87b29cf2-858bb5b505c9bea4c73a25f4"}],
      "earlyAlertSuggestionOtherDescription" : null,closed":false, 
      "comment" : null}
    ]
}

Get an Early Alert Response

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

Security

PERSON_EARLY_ALERT_RESPONSE_READ

Returns

EarlyAlert

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : "createdById
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "createdDatefirstName" : "1332216000000John",
     "modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Doe"},
 "modifiedDatecreatedDate" : "1332216000000",
 "objectStatus"modifiedBy" : 
    {"id" : "ACTIVE91f46e39-cea8-422b-b215-00f6bcf5d280",
     "courseNamefirstName" : "MTH-100John",
     "courseTitlelastName" : "Introduction to MathDoe"},
 "emailCCmodifiedDate" : "john.smith@university.edu1332216000000",
 "campusIdobjectStatus" : 1"ACTIVE",
 "earlyAlertReasonIdsearlyAlertOutreachIds" : 
    [{"id" : "e02521fc198c1b80-53cafee5-4fe64ece-8de7aefb-b2a1fb3d08f797c23beac116"},
     {"id" : "216a272f3fd7e44d-a457dc33-447e4519-9bc29e93-72ee5436a8b1dc85d24f9074"}],
 "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
 "earlyAlertReasonOtherDescriptionearlyAlertOutcomeOtherDescription" : null,
 "earlyAlertSuggestionIdsearlyAlertReferralIds" :  
    [{"id" : "b04b0b524139a3ba-c0e8b7fa-4cc54ff3-83baab09-5252910f012a43cf3d9de8a6"},
     {"id" : "d071947330a17f21-a17a6aaa-44e549fb-8d638b0b-541870b9983ebd53585ed3ac"}],
 "earlyAlertSuggestionOtherDescriptionclosed" :false, null,
 "comment" : "StudentFollow-up isvia strugglingPhone. in MTH class and frequently sleepsAppt scheduled."}

Create an Early Alert Response

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

Security

PERSON_EARLY_ALERT_RESPONSE_WRITE

Sample Post

Code Block

{"courseNameearlyAlertOutreachIds" : "MTH-101",
 "courseTitle" :
"Concepts of Math",  [{"emailCCid" : "john.smith@university.edu",
 "campusId" : 1198c1b80-fee5-4ece-aefb-97c23beac116"},
 "earlyAlertReasonIds" :      [{"id" : "e02521fc3fd7e44d-53cadc33-4fe64519-8de79e93-b2a1fb3d08f7dc85d24f9074"}],
     {"idearlyAlertOutcomeId" : "216a272f85fa1583-a45774b4-447e47fe-9bc29edd-72ee5436a8b1e5c9da9e11f2"}],
 "earlyAlertReasonOtherDescriptionearlyAlertOutcomeOtherDescription" : null,
 "earlyAlertSuggestionIdsearlyAlertReferralIds" : 
    [{"id" : "b04b0b524139a3ba-c0e8b7fa-4cc54ff3-83baab09-5252910f012a43cf3d9de8a6"},
     {"id" : "d071947330a17f21-a17a6aaa-44e549fb-8d638b0b-541870b9983ebd53585ed3ac"}],
 "earlyAlertSuggestionOtherDescription" : null,
 "comment" : "StudentFollow-up isvia oftenPhone. late to class and isn't preparedAppt scheduled."}

Returns

EarlyAlertResponse

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "createdDatefirstName" : "1332216000000John",
     "modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Doe"},
 "modifiedDatecreatedDate" : "1332216000000",
 "modifiedBy" : 
    {"objectStatusid" : "ACTIVE91f46e39-cea8-422b-b215-00f6bcf5d280",
     "courseNamefirstName" : "MTH-101John",
     "courseTitlelastName" : "Concepts of MathDoe"},
 "emailCCmodifiedDate" : "john.smith@university.edu1332216000000",
 "campusIdobjectStatus" : 1"ACTIVE",
 "earlyAlertReasonIdsearlyAlertOutreachIds" : 
    [{"id" : "e02521fc198c1b80-53cafee5-4fe64ece-8de7aefb-b2a1fb3d08f797c23beac116"},
     {"id" : "216a272f3fd7e44d-a457dc33-447e4519-9bc29e93-72ee5436a8b1dc85d24f9074"}],
 "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
 "earlyAlertReasonOtherDescriptionearlyAlertOutcomeOtherDescription" : null,
 "earlyAlertSuggestionIdsearlyAlertReferralIds" : 
    [{"id" : "b04b0b524139a3ba-c0e8b7fa-4cc54ff3-83baab09-5252910f012a43cf3d9de8a6"},
     {"id" : "d071947330a17f21-a17a6aaa-44e549fb-8d638b0b-541870b9983ebd53585ed3ac"}],
 "earlyAlertSuggestionOtherDescriptionclosed" :false, null,
 "comment" : "StudentFollow-up isvia oftenPhone. late to class and isn't preparedAppt scheduled."}

Save an Early Alert Response

Warning
PUT Method was dropped in v1.2.0. Early Alert Responses cannot be updated via the API starting with v1.2.0

Only available through v1.1.X

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

Security

PERSON_EARLY_ALERT_RESPONSE_WRITE

Sample Post

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "createdDatefirstName" : "1332216000000John",
     "modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Doe"},
 "modifiedDatecreatedDate" : "1332216000000",
 "modifiedBy" : 
    {"objectStatusid" : "ACTIVE91f46e39-cea8-422b-b215-00f6bcf5d280",
     "courseNamefirstName" : "MTH-100John",
     "courseTitlelastName" : "Introduction to MathDoe"},
 "emailCCmodifiedDate" : "john.smith@university.edu1332216000000",
 "campusIdobjectStatus" : 1"ACTIVE",
 "earlyAlertReasonIdsearlyAlertOutreachIds" : 
    [{"id" : "e02521fc198c1b80-53cafee5-4fe64ece-8de7aefb-b2a1fb3d08f797c23beac116"},
     {"id" : "216a272f3fd7e44d-a457dc33-447e4519-9bc29e93-72ee5436a8b1dc85d24f9074"}],
 "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
 "earlyAlertReasonOtherDescriptionearlyAlertOutcomeOtherDescription" : null,
 "earlyAlertSuggestionIdsearlyAlertReferralIds" : 
    [{"id" : "b04b0b524139a3ba-c0e8b7fa-4cc54ff3-83baab09-5252910f012a43cf3d9de8a6"},
     {"id" : "d071947330a17f21-a17a6aaa-44e549fb-8d638b0b-541870b9983ebd53585ed3ac"}],
 "earlyAlertSuggestionOtherDescriptionclosed" :false, null, 
"comment" : "StudentFollow-up isvia strugglingPhone. in MTH class and frequently sleepsAppt scheduled."}

Returns

EarlyAlertResponse

Code Block

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "createdDatefirstName" : "1332216000000John",
     "modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Doe"},
 "modifiedDatecreatedDate" : "1332216000000",
 "modifiedBy" : "objectStatus
    {"id" : "ACTIVE91f46e39-cea8-422b-b215-00f6bcf5d280",
     "courseNamefirstName" : "MTH-100John",
     "courseTitlelastName" : "Introduction to MathDoe"},
 "emailCCmodifiedDate" : "john.smith@university.edu1332216000000",
 "campusIdobjectStatus" : 1"ACTIVE",
 "earlyAlertReasonIdsearlyAlertOutreachIds" : 
    [{"id" : "e02521fc198c1b80-53cafee5-4fe64ece-8de7aefb-b2a1fb3d08f797c23beac116"},
     {"id" : "216a272f3fd7e44d-a457dc33-447e4519-9bc29e93-72ee5436a8b1dc85d24f9074"}],
 "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
 "earlyAlertReasonOtherDescriptionearlyAlertOutcomeOtherDescription" : null,
 "earlyAlertSuggestionIdsearlyAlertReferralIds" : 
    [{"id" : "b04b0b524139a3ba-c0e8b7fa-4cc54ff3-83baab09-5252910f012a43cf3d9de8a6"},
     {"id" : "d071947330a17f21-a17a6aaa-44e549fb-8d638b0b-541870b9983ebd53585ed3ac"}],
 "closed":false, 
 "earlyAlertSuggestionOtherDescriptioncomment" : null, "Follow-up via Phone.  Appt scheduled."}

Delete an Early Alert Response

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

Security

PERSON_EARLY_ALERT_RESPONSE_DELETE

Returns

Code Block
{"success" : "true"}

...

Versions Compared

Old Version 1

New Version Current

Key

Get All

Responses for an Early Alert

Get an Early Alert Response

Create an Early Alert Response

Save an Early Alert Response

Delete an Early Alert Response