Watch A Student
POST /ssp/api/1/person/[watcher id]/watchstudent/
Security
PERSON_WATCHLIST_WRITE
BULK_WATCHLIST_WRITE
Method: Post
{ "id":"",
"studentId":"0beff43f-f3c1-4689-be35-72d4972ec160",
"watcherId":"c0a80097-4b52-1f09-814b-5235b24f0001"
}
Returns
{
"id":"c0a80097-5047-1231-8150-477cc8760000",
"createdDate":1444308371574,
"createdBy":{
"id":"c0a80097-4b52-1f09-814b-5235b24f0001",
"firstName":null,
"lastName":null,
"fullName":"null null"
},
"modifiedDate":1444308371574,
"modifiedBy":{
"id":"c0a80097-4b52-1f09-814b-5235b24f0001",
"firstName":null,
"lastName":null,
"fullName":"null null"
},
"objectStatus":"ACTIVE",
"watcherId":"c0a80097-4b52-1f09-814b-5235b24f0001",
"studentId":"0beff43f-f3c1-4689-be35-72d4972ec160",
"watchDate":1444308371574
}
Un-Watch A Student
DELETE /ssp/api/1/person/{watcher id}/watchstudent/{student id}
Security
PERSON_WATCHLIST_DELETE
Method: Delete
{
"id":"c0a80097-5047-1231-8150-477cc8760000",
"studentId":"0beff43f-f3c1-4689-be35-72d4972ec160",
"watcherId":"c0a80097-4b52-1f09-814b-5235b24f0001"
}
Returns
{"success":"true","message":""}
Watchlist
POST /ssp/1/person/{personId}/watchstudent/whoiswatching
Security
PERSON_WATCHLIST_READ
Parameters
- Limit
- Program Status
- Status
- Page
- Start
- Sort
- SortDirection
Returns
{
"success":"true",
"message":"",
"results":9,
"rows":[
{
"personId":"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
"schoolId":"janderson218",
"firstName":"James",
"middleName":"Jacob",
"lastName":"Anderson",
"primaryEmailAddress":"demo@trainingssp.com",
"birthDate":"1986-10-24",
"studentTypeName":"Non-Degree Seeking",
"currentAppointmentStartTime":null,
"studentIntakeComplete":false,
"numberOfEarlyAlerts":2,
"numberEarlyAlertResponsesRequired":2,
"id":"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
"coachId":"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
"coachFirstName":"Demo",
"coachLastName":"Coach13",
"photoUrl":null,
"currentProgramStatusName":"Active",
"campusName":"North Campus"
},
{
"personId":"977873db-7a0e-45e2-bea0-6e332ccce428",
"schoolId":"manderson1",
"firstName":"Mary",
"middleName":"Rose",
"lastName":"Anderson",
"primaryEmailAddress":"demo@trainingssp.com",
"birthDate":"1988-01-04",
"studentTypeName":"Non-Degree Seeking",
"currentAppointmentStartTime":null,
"studentIntakeComplete":false,
"numberOfEarlyAlerts":8,
"numberEarlyAlertResponsesRequired":8,
"id":"977873db-7a0e-45e2-bea0-6e332ccce428",
"coachId":"104e3042-75f0-4460-ad47-2b2335f2f7d9",
"coachFirstName":"Demo",
"coachLastName":"Coach1",
"photoUrl":null,
"currentProgramStatusName":"Active",
"campusName":"North Campus"
},
{
"personId":"d2ed8977-aebc-4ab0-98ce-a2b1bcbdd453",
"schoolId":"tbrown22",
"firstName":"Thomas",
"middleName":"Jason",
"lastName":"Brown",
"primaryEmailAddress":"demo@trainingssp.com",
"birthDate":"1983-08-20",
"studentTypeName":"Transfer",
"currentAppointmentStartTime":null,
"studentIntakeComplete":true,
"numberOfEarlyAlerts":1,
"numberEarlyAlertResponsesRequired":1,
"id":"d2ed8977-aebc-4ab0-98ce-a2b1bcbdd453",
"coachId":"61460dd3-a6de-4c06-a1a3-348087146a9b",
"coachFirstName":"Demo",
"coachLastName":"Coach8",
"photoUrl":null,
"currentProgramStatusName":"Active",
"campusName":"North Campus"
},
{
"personId":"a4a4c014-776b-4002-935d-98efee7ec6a3",
"schoolId":"jgarcia35",
"firstName":"John",
"middleName":"Matthew",
"lastName":"Garcia",
"primaryEmailAddress":"demo@trainingssp.com",
"birthDate":"1986-10-24",
"studentTypeName":"First Time in College",
"currentAppointmentStartTime":null,
"studentIntakeComplete":true,
"numberOfEarlyAlerts":2,
"numberEarlyAlertResponsesRequired":2,
"id":"a4a4c014-776b-4002-935d-98efee7ec6a3",
"coachId":"5974f03d-03d4-4632-93ee-52581930b1d0",
"coachFirstName":"Demo",
"coachLastName":"Coach18",
"photoUrl":null,
"currentProgramStatusName":"Active",
"campusName":"North Campus"
}
]
}
Watchers
POST /ssp/1/person/{personId}/watchstudent/whoiswatching
Security
PERSON_WATCHLIST_READ
Parameters
- page
- start
- limit
- sort
- sortDirection
Method: Post
Returns
{
"success":"true",
"message":"",
"results":4,
"rows":[
{
"id":"67648cba-18d8-4445-ab72-0af31c4747d3",
"createdDate":1356998400000,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1356998400000,
"modifiedBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"objectStatus":"ACTIVE",
"firstName":"Demo",
"middleName":"",
"lastName":"Coach12",
"birthDate":"1968-01-04",
"primaryEmailAddress":"demo@trainingssp.com",
"secondaryEmailAddress":"demo2@trainingssp.com",
"username":"coach12",
"homePhone":"(555) 555-5555",
"workPhone":"(777) 777-7777",
"cellPhone":"(888) 888-8888",
"alternatePhone":null,
"nonLocalAddress":null,
"addressLine1":"123 W. Demo St.",
"addressLine2":"Apt. 555",
"city":"Phoenix",
"state":"AZ",
"zipCode":"55555 ",
"alternateAddressInUse":null,
"alternateAddressLine1":null,
"alternateAddressLine2":null,
"alternateAddressCity":null,
"alternateAddressState":null,
"alternateAddressZipCode":null,
"alternateAddressCountry":null,
"photoUrl":null,
"schoolId":"coach12",
"enabled":true,
"studentIntakeCompleteDate":null,
"studentType":null,
"coach":null,
"abilityToBenefit":null,
"anticipatedStartTerm":null,
"anticipatedStartYear":null,
"actualStartTerm":null,
"actualStartYear":null,
"studentIntakeRequestDate":null,
"specialServiceGroups":null,
"referralSources":null,
"serviceReasons":null,
"confidentialityLevels":null,
"permissions":null,
"currentProgramStatusName":null,
"programStatusChangeReasonName":null,
"registeredForCurrentTerm":false,
"activeAlertsCount":0,
"closedAlertsCount":0,
"residencyCounty":"DemoCounty",
"f1Status":null,
"gender":null,
"maritalStatus":null,
"ethnicity":null,
"race":null,
"actionPlanTaskOpenCount":0,
"actionPlanTaskClosedCount":0,
"lastActionPlanCompletedDate":null,
"confidentialityDisclosureAgreementSignedDate":null,
"homeCampus":{
"id":"0a640a2a-409d-1271-8140-d10a51770117",
"name":"West Campus",
"objectStatus":"ACTIVE"
},
"formattedCDACompleteDate":null,
"formattedStudentIntakeCompleteDate":null
},
{
"id":"c0a80097-4b52-1f09-814b-5235b24f0001",
"createdDate":1423013425743,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1423013425743,
"modifiedBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"objectStatus":"ACTIVE",
"firstName":"Amy",
"middleName":null,
"lastName":"Administrator",
"birthDate":null,
"primaryEmailAddress":"amy.administrator@university.edu",
"secondaryEmailAddress":null,
"username":"admin",
"homePhone":null,
"workPhone":null,
"cellPhone":null,
"alternatePhone":null,
"nonLocalAddress":null,
"addressLine1":null,
"addressLine2":null,
"city":null,
"state":null,
"zipCode":null,
"alternateAddressInUse":null,
"alternateAddressLine1":null,
"alternateAddressLine2":null,
"alternateAddressCity":null,
"alternateAddressState":null,
"alternateAddressZipCode":null,
"alternateAddressCountry":null,
"photoUrl":null,
"schoolId":"admin",
"enabled":true,
"studentIntakeCompleteDate":null,
"studentType":null,
"coach":null,
"abilityToBenefit":null,
"anticipatedStartTerm":null,
"anticipatedStartYear":null,
"actualStartTerm":null,
"actualStartYear":null,
"studentIntakeRequestDate":null,
"specialServiceGroups":null,
"referralSources":null,
"serviceReasons":null,
"confidentialityLevels":null,
"permissions":null,
"currentProgramStatusName":null,
"programStatusChangeReasonName":null,
"registeredForCurrentTerm":false,
"activeAlertsCount":0,
"closedAlertsCount":0,
"residencyCounty":null,
"f1Status":null,
"gender":null,
"maritalStatus":null,
"ethnicity":null,
"race":null,
"actionPlanTaskOpenCount":3,
"actionPlanTaskClosedCount":1,
"lastActionPlanCompletedDate":1435243290607,
"confidentialityDisclosureAgreementSignedDate":null,
"homeCampus":{
"id":"0a640a2a-409d-1271-8140-d10a51770117",
"name":"West Campus",
"objectStatus":"ACTIVE"
},
"formattedCDACompleteDate":null,
"formattedStudentIntakeCompleteDate":null
},
{
"id":"f93d01f5-1a98-4f9e-a405-ac837a5ca1fe",
"createdDate":1356998400000,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1356998400000,
"modifiedBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"objectStatus":"ACTIVE",
"firstName":"Demo",
"middleName":"",
"lastName":"Coach15",
"birthDate":"1968-01-04",
"primaryEmailAddress":"demo@trainingssp.com",
"secondaryEmailAddress":"demo2@trainingssp.com",
"username":"coach15",
"homePhone":"(555) 555-5555",
"workPhone":"(777) 777-7777",
"cellPhone":"(888) 888-8888",
"alternatePhone":null,
"nonLocalAddress":null,
"addressLine1":"123 W. Demo St.",
"addressLine2":"Apt. 555",
"city":"Phoenix",
"state":"AZ",
"zipCode":"55555 ",
"alternateAddressInUse":null,
"alternateAddressLine1":null,
"alternateAddressLine2":null,
"alternateAddressCity":null,
"alternateAddressState":null,
"alternateAddressZipCode":null,
"alternateAddressCountry":null,
"photoUrl":null,
"schoolId":"coach15",
"enabled":true,
"studentIntakeCompleteDate":null,
"studentType":null,
"coach":null,
"abilityToBenefit":null,
"anticipatedStartTerm":null,
"anticipatedStartYear":null,
"actualStartTerm":null,
"actualStartYear":null,
"studentIntakeRequestDate":null,
"specialServiceGroups":null,
"referralSources":null,
"serviceReasons":null,
"confidentialityLevels":null,
"permissions":null,
"currentProgramStatusName":null,
"programStatusChangeReasonName":null,
"registeredForCurrentTerm":false,
"activeAlertsCount":0,
"closedAlertsCount":0,
"residencyCounty":"DemoCounty",
"f1Status":null,
"gender":null,
"maritalStatus":null,
"ethnicity":null,
"race":null,
"actionPlanTaskOpenCount":0,
"actionPlanTaskClosedCount":0,
"lastActionPlanCompletedDate":null,
"confidentialityDisclosureAgreementSignedDate":null,
"homeCampus":{
"id":"0a640a2a-409d-1271-8140-d10a51770117",
"name":"West Campus",
"objectStatus":"ACTIVE"
},
"formattedCDACompleteDate":null,
"formattedStudentIntakeCompleteDate":null
},
{
"id":"8822c237-7aa0-42b8-9dbe-3346ddbcda44",
"createdDate":1356998400000,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1356998400000,
"modifiedBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"objectStatus":"ACTIVE",
"firstName":"Demo",
"middleName":"",
"lastName":"Coach16",
"birthDate":"1968-01-04",
"primaryEmailAddress":"demo@trainingssp.com",
"secondaryEmailAddress":"demo2@trainingssp.com",
"username":"coach16",
"homePhone":"(555) 555-5555",
"workPhone":"(777) 777-7777",
"cellPhone":"(888) 888-8888",
"alternatePhone":null,
"nonLocalAddress":null,
"addressLine1":"123 W. Demo St.",
"addressLine2":"Apt. 555",
"city":"Phoenix",
"state":"AZ",
"zipCode":"55555 ",
"alternateAddressInUse":null,
"alternateAddressLine1":null,
"alternateAddressLine2":null,
"alternateAddressCity":null,
"alternateAddressState":null,
"alternateAddressZipCode":null,
"alternateAddressCountry":null,
"photoUrl":null,
"schoolId":"coach16",
"enabled":true,
"studentIntakeCompleteDate":null,
"studentType":null,
"coach":null,
"abilityToBenefit":null,
"anticipatedStartTerm":null,
"anticipatedStartYear":null,
"actualStartTerm":null,
"actualStartYear":null,
"studentIntakeRequestDate":null,
"specialServiceGroups":null,
"referralSources":null,
"serviceReasons":null,
"confidentialityLevels":null,
"permissions":null,
"currentProgramStatusName":null,
"programStatusChangeReasonName":null,
"registeredForCurrentTerm":false,
"activeAlertsCount":0,
"closedAlertsCount":0,
"residencyCounty":"DemoCounty",
"f1Status":null,
"gender":null,
"maritalStatus":null,
"ethnicity":null,
"race":null,
"actionPlanTaskOpenCount":0,
"actionPlanTaskClosedCount":0,
"lastActionPlanCompletedDate":null,
"confidentialityDisclosureAgreementSignedDate":null,
"homeCampus":{
"id":"0a640a2a-409d-1271-8140-d10a51770117",
"name":"West Campus",
"objectStatus":"ACTIVE"
},
"formattedCDACompleteDate":null,
"formattedStudentIntakeCompleteDate":null
}
]
}