Page Comparison

Description

The Early Alert Routings define any additional parties that are to receive EA communication when an EA is received in the SSP system. These routings are setup by campus and early alert reason.
The routing may define a person to receive the communication, a group (with name and email distribution list), or both.

Get All Early Alert Routings for Campus

GET /ssp/api/1/reference/campus/{id}/earlyAlertRouting

Security

SERVICE_REFERENCE_READ

Parameters

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)

...

Code Block

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "createdDate" : 1332216000000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "modifiedDate" : 1332216000000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "objectStatus" : "ACTIVE",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "person" : 
         {"id" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
          "firstName" : "Angie",
          "lastName" : "Advisor"},
      "groupName" : null,
      "groupEmail" : null},
     {"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
      "createdDate" : 1332216000000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "modifiedDate" : 1332216000000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "objectStatus" : "ACTIVE",
      "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "person" : null,
      "groupName" : "Excessive Absences Email Group",
      "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
}

Get a Campus Early Alert Routing

GET /ssp/api/1/reference/campus/{id}/earlyAlertRouting{id}

Security

SERVICE_REFERENCE_READ

Returns

EarlyAlertRouting

Code Block

{"id" : "6201b18daeb21037-9d1d512a-48d34c7e-82d4-092e52ad676b"a6fa-cd26ea533cc6",
 "createdDate" : 1332216000000,
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 
 "createdDatemodifiedDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "nameearlyAlertReasonId" : "Main Campus",
 "description" : "Main campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d2806201b18d-9d1d-48d3-82d4-092e52ad676b",
 "earlyAlertRoutingsperson" : 
   [ {"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",

     "groupNamefirstName" : null,
      "groupEmail" : null}"Angie",
     {"idlastName" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813"Advisor"},
      "earlyAlertReasonIdgroupName" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "personId" : null,
      "groupName" : "Excessive Absences Email Group",
      "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
null}

Create a Campus Early Alert Routing

POST /ssp/api/1/reference/campus/{id}/earlyAlertRouting

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block

{"descriptionearlyAlertReasonId" : "Main campus.",
 "name" : "Main Campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d2806201b18d-9d1d-48d3-82d4-092e52ad676b",
 "earlyAlertRoutingsperson" : 
   [ {"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
      "groupNamefirstName" : null,
      "groupEmail" : null}"Angie",
     {"idlastName" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813"Advisor"},
      "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "personId""groupName" : null,
    
 "groupName" : "Excessive Absences Email Group",
      "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
null}

Returns

CampusEarlyAlertRouting

Code Block

{"id" : "6201b18daeb21037-9d1d512a-48d34c7e-82d4-092e52ad676b"a6fa-cd26ea533cc6",
 "createdDate" : 1332216000000,
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDatemodifiedDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "nameearlyAlertReasonId" : "Main Campus",
 "description" : "Main campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d2806201b18d-9d1d-48d3-82d4-092e52ad676b",
 "earlyAlertRoutingsperson" : 
   [ {"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",       "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
      "groupNamefirstName" : null,
      "groupEmail" : null}"Angie",
     {"idlastName" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813"Advisor"},
      "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "personId""groupName" : null,
      "groupName"
: "Excessive Absences Email Group",
      "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
null}

Save a Campus Early Alert Routing

PUT /ssp/api/1/reference/campus/{id}/earlyAlertRouting/{id}

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block

{"id" : "6201b18daeb21037-9d1d512a-48d34c7e-82d4-092e52ad676b"a6fa-cd26ea533cc6",
 "createdDate" : 1332216000000,
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
  "createdDatemodifiedDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "nameearlyAlertReasonId" : "Main Campus",
 "description" : "Main campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d2806201b18d-9d1d-48d3-82d4-092e52ad676b",
 "earlyAlertRoutingsperson" : 
   [ {"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
      "groupNamefirstName" : null,
      "groupEmailAngie" : null},
     {"idlastName" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813"Advisor"},
      "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "personId""groupName" : null,
      "groupName" : "Excessive Absences Email Group",
    
 "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
}null}

Returns

CampusEarlyAlertRouting

Code Block

{"id" : "6201b18daeb21037-9d1d512a-48d34c7e-82d4-092e52ad676b"a6fa-cd26ea533cc6",
 "createdDate" : 1332216000000,
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 
 "createdDatemodifiedDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
  "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "nameearlyAlertReasonId" : "Main Campus",
 "description" : "Main campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d2806201b18d-9d1d-48d3-82d4-092e52ad676b",
 "earlyAlertRoutingsperson" : 
   [ {"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
      "groupNamefirstName" : null,
      "groupEmailAngie" : null},
     {"idlastName" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813"Advisor"},
      "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "personId"groupName" : null,
      "groupName" : "Excessive Absences Email Group",
    
 "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
}null}

Delete a Campus Early Alert Routing

DELETE /ssp/api/1/reference/campus/{id}/earlyAlertRouting/{id}

Security

SERVICE_REFERENCE_WRITE

Returns

Code Block
{"success" : "true"}

...

Versions Compared

Old Version 1

New Version Current

Key

Description

Get All Early Alert Routings for Campus

Get a Campus Early Alert Routing

Create a Campus Early Alert Routing

Save a Campus Early Alert Routing

Delete a Campus Early Alert Routing