Person Early Alert Response API

Owned by Alexander Leader
Last updated: Mar 24, 2013 by Jason ElwoodVersion comment
4 min read

Get All Responses for an Early Alert

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

Security

PERSON_EARLY_ALERT_RESPONSE_READ

Parameters

status : ALL, ACTIVE, INACTIVE
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

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "createdDate" : "1332216000000",
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "modifiedDate" : "1332216000000",
      "objectStatus" : "ACTIVE",
      "earlyAlertOutreachIds" : 
         [{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"},
          {"id" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
      "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
      "earlyAlertOutcomeOtherDescription" : null,
      "earlyAlertReferralIds" : 
         [{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
          {"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
      "comment" : "Follow-up via Phone.  Appt scheduled."},
     {"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "createdDate" : "1332216000000",
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "modifiedDate" : "1332216000000",
      "objectStatus" : "ACTIVE",
      "earlyAlertOutreachIds" : 
         [{"id" : "88b9bd08-5814-44d4-8ff2-1667597f8bba"},
          {"id" : "6373d1ef-d2a2-48a7-aa78-c0b4a29da3ef"}],
      "earlyAlertOutcomeId" : "00c42b84-88fe-4bc9-8cef-723cd6a26c65",
      "earlyAlertOutcomeOtherDescription" : "Student stopped by.",
      "earlyAlertReferralIds" : 
         [{"id" : "b2f52c40-82dd-4b09-9ec0-06f98c0c54c9"},
          {"id" : "6ef6aca6-4fd6-4bd2-9cf2-bea4c73a25f4"}],
      "closed":false, 
      "comment" : null}
    ]
}

Get an Early Alert Response

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

Security

PERSON_EARLY_ALERT_RESPONSE_READ

Returns

EarlyAlert

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "createdDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "earlyAlertOutreachIds" : 
    [{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"},
     {"id" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
 "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
 "earlyAlertOutcomeOtherDescription" : null,
 "earlyAlertReferralIds" : 
    [{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
     {"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
 "closed":false, 
 "comment" : "Follow-up via Phone.  Appt scheduled."}

 

Create an Early Alert Response

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

Security

PERSON_EARLY_ALERT_RESPONSE_WRITE

Sample Post

{"earlyAlertOutreachIds" : 
    [{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"},
     {"id" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
 "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
 "earlyAlertOutcomeOtherDescription" : null,
 "earlyAlertReferralIds" : 
    [{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
     {"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
 "comment" : "Follow-up via Phone.  Appt scheduled."}

Returns

EarlyAlertResponse

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "createdDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "earlyAlertOutreachIds" : 
    [{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"},
     {"id" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
 "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
 "earlyAlertOutcomeOtherDescription" : null,
 "earlyAlertReferralIds" : 
    [{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
     {"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
 "closed":false, 
 "comment" : "Follow-up via Phone.  Appt scheduled."}

 

Save an Early Alert Response

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}/response/{id}

Security

PERSON_EARLY_ALERT_RESPONSE_WRITE

Sample Post

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "createdDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "earlyAlertOutreachIds" : 
    [{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"},
     {"id" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
 "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
 "earlyAlertOutcomeOtherDescription" : null,
 "earlyAlertReferralIds" : 
    [{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
     {"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
"closed":false,  
"comment" : "Follow-up via Phone.  Appt scheduled."}

Returns

EarlyAlertResponse

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "createdDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "earlyAlertOutreachIds" : 
    [{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"},
     {"id" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
 "earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
 "earlyAlertOutcomeOtherDescription" : null,
 "earlyAlertReferralIds" : 
    [{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
     {"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
 "closed":false, 
 "comment" : "Follow-up via Phone.  Appt scheduled."}

 

Delete an Early Alert Response

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

Security

PERSON_EARLY_ALERT_RESPONSE_DELETE

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}