Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Get All Early Alert Routings for Campus

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

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)

Returns

{"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 an Early Alert Routing

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

Returns

EarlyAlertRouting

{"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}

 

Create an Early Alert Routing

POST /ssp/api/1/reference/earlyAlertRouting

Sample Post

{"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "person" : 
    {"id" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
     "firstName" : "Angie",
     "lastName" : "Advisor"},
 "groupName" : null,
 "groupEmail" : null}

Returns

EarlyAlertRouting

{"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}

 

Save an Early Alert Routing

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

Sample Post

{"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}

Returns

EarlyAlertRouting

{"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}

 

Delete an Early Alert Routing

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

Returns

{"success" : "true"}

or

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