...
| Code Block |
|---|
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"createdDate" : 1331269200000,
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : 1331269200000,
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"firstName" : "Sally",
"middleName" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"nonLocalAddress" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"alternateAddressLineInUse" : null,
"alternateAddressLine1" : null,
"alternateAddressLine2" : null,
"alternateAddressCity" : null,
"alternateAddressState" : null,
"alternateAddressZipCode" : null,
"alternateAddressCountry" : null,
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"studentIntakeCompleteDate" : null,
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"
"objectStatus":"ACTIVE"},},
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor",
"primaryEmailAddress" : "amy.advisor@university.edu",
"workPhone" : "(123) 456-7890",
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"
"photoUrl":"http://192.168.0.151:8080/images/0000000.png"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"actualStartTerm":"Fall",
"actualStartYear":2012,
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroups" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"name" : "Basketball Team",
"objectStatus" : "ACTIVE"}
],
"referralSources" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
"name" : "Counseling Services".
"objectStatus" : "ACTIVE"},
],
"serviceReasons" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
"name" : "Developmental Education",
"objectStatus" : "ACTIVE"}
],
"confidentialityLevels" : null,
"permissions" : null,
"currentProgramStatusName" : "Active",
"registeredForCurrentTerm" : true
"activeAlertsCount":1,
"closedAlertsCount":2,
"paymentStatus":"Y Y Y",
"registeredTerms":"2013FA 2013SP 2013SU"
"residencyCounty":"Butler",
"f1Status":"Y",
"gender":"M",
"maritalStatus":"Single",
"ethnicity":null,
"actionPlanTaskOpenCount":4,
"actionPlanTaskClosedCount":15,
"lastActionPlanCompletedDate":1367297284590
"formattedStudentIntakeCompleteDate":null}
]
} |
Get All Persons Who Are Coaches
...
| Code Block |
|---|
[{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"createdDate" : 1331269200000,
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : 1331269200000,
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"firstName" : "Sally",
"middleName" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"nonLocalAddress" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"alternateAddressLineInUse" : null,
"alternateAddressLine1" : null,
"alternateAddressLine2" : null,
"alternateAddressCity" : null,
"alternateAddressState" : null,
"alternateAddressZipCode" : null,
"alternateAddressCountry" : null,
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"studentIntakeCompleteDate" : null,
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"
"objectStatus":"ACTIVE"},},
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor",
"primaryEmailAddress" : "amy.advisor@university.edu",
"workPhone" : "(123) 456-7890",
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"
"photoUrl":"http://192.168.0.151:8080/images/0000000.png"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"actualStartTerm":"Fall",
"actualStartYear":2012,
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroups" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"name" : "Basketball Team",
"objectStatus" : "ACTIVE"}
],
"referralSources" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
"name" : "Counseling Services".
"objectStatus" : "ACTIVE"},
],
"serviceReasons" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
"name" : "Developmental Education",
"objectStatus" : "ACTIVE"}
],
"confidentialityLevels" : null,
"permissions" : null,
"currentProgramStatusName" : "Active",
"registeredForCurrentTerm" : true
"activeAlertsCount":1,
"closedAlertsCount":2,
"paymentStatus":"Y Y Y",
"registeredTerms":"2013FA 2013SP 2013SU"
"residencyCounty":"Butler",
"f1Status":"Y",
"gender":"M",
"maritalStatus":"Single",
"ethnicity":null,
"actionPlanTaskOpenCount":4,
"actionPlanTaskClosedCount":15,
"lastActionPlanCompletedDate":1367297284590
"formattedStudentIntakeCompleteDate":null}
]
} |
Get a Person by School ID
...
| Code Block |
|---|
[{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"createdDate" : 1331269200000,
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : 1331269200000,
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"firstName" : "Sally",
"middleName" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"nonLocalAddress" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"alternateAddressLineInUse" : null,
"alternateAddressLine1" : null,
"alternateAddressLine2" : null,
"alternateAddressCity" : null,
"alternateAddressState" : null,
"alternateAddressZipCode" : null,
"alternateAddressCountry" : null,
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"studentIntakeCompleteDate" : null,
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"
"objectStatus":"ACTIVE"},},
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor",
"primaryEmailAddress" : "amy.advisor@university.edu",
"workPhone" : "(123) 456-7890",
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"
"photoUrl":"http://192.168.0.151:8080/images/0000000.png"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"actualStartTerm":"Fall",
"actualStartYear":2012,
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroups" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"name" : "Basketball Team",
"objectStatus" : "ACTIVE"}
],
"referralSources" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
"name" : "Counseling Services".
"objectStatus" : "ACTIVE"},
],
"serviceReasons" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
"name" : "Developmental Education",
"objectStatus" : "ACTIVE"}
],
"confidentialityLevels" : null,
"permissions" : null,
"currentProgramStatusName" : "Active",
"registeredForCurrentTerm" : true
"activeAlertsCount":1,
"closedAlertsCount":2,
"paymentStatus":"Y Y Y",
"registeredTerms":"2013FA 2013SP 2013SU"
"residencyCounty":"Butler",
"f1Status":"Y",
"gender":"M",
"maritalStatus":"Single",
"ethnicity":null,
"actionPlanTaskOpenCount":4,
"actionPlanTaskClosedCount":15,
"lastActionPlanCompletedDate":1367297284590
"formattedStudentIntakeCompleteDate":null}
]
} |
Create a Person
POST /ssp/api/1/person
...
| Code Block |
|---|
{ "firstName" : "Sally",
"middleName" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"nonLocalAddress" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"alternateAddressLineInUse" : null,
"alternateAddressLine1" : null,
"alternateAddressLine2" : null,
"alternateAddressCity" : null,
"alternateAddressState" : null,
"alternateAddressZipCode" : null,
"alternateAddressCountry" : null,
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"studentIntakeCompleteDate" : null,
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"
"objectStatus":"ACTIVE"},},
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor",
"primaryEmailAddress" : "amy.advisor@university.edu",
"workPhone" : "(123) 456-7890",
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"
"photoUrl":"http://192.168.0.151:8080/images/0000000.png"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"actualStartTerm":"Fall",
"actualStartYear":2012,
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroups" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"name" : "Basketball Team",
"objectStatus" : "ACTIVE"}
],
"referralSources" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
"name" : "Counseling Services".
"objectStatus" : "ACTIVE"},
],
"serviceReasons" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
"name" : "Developmental Education",
"objectStatus" : "ACTIVE"}
],
"confidentialityLevels" : null,
"permissions" : null,
"currentProgramStatusName" : "Active",
"registeredForCurrentTerm" : true
"activeAlertsCount":1,
"closedAlertsCount":2,
"paymentStatus":"Y Y Y",
"registeredTerms":"2013FA 2013SP 2013SU"
"residencyCounty":"Butler",
"f1Status":"Y",
"gender":"M",
"maritalStatus":"Single",
"ethnicity":null,
"actionPlanTaskOpenCount":4,
"actionPlanTaskClosedCount":15,
"lastActionPlanCompletedDate":1367297284590
"formattedStudentIntakeCompleteDate":null}
]
} |
Returns
Person
| Code Block |
|---|
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"createdDate" : 1331269200000,
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : 1331269200000,
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"firstName" : "Sally",
"middleName" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"nonLocalAddress" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"alternateAddressLineInUse" : null,
"alternateAddressLine1" : null,
"alternateAddressLine2" : null,
"alternateAddressCity" : null,
"alternateAddressState" : null,
"alternateAddressZipCode" : null,
"alternateAddressCountry" : null,
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"studentIntakeCompleteDate" : null,
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"
"objectStatus":"ACTIVE"},},
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor",
"primaryEmailAddress" : "amy.advisor@university.edu",
"workPhone" : "(123) 456-7890",
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"
"photoUrl":"http://192.168.0.151:8080/images/0000000.png"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"actualStartTerm":"Fall",
"actualStartYear":2012,
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroups" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"name" : "Basketball Team",
"objectStatus" : "ACTIVE"}
],
"referralSources" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
"name" : "Counseling Services".
"objectStatus" : "ACTIVE"},
],
"serviceReasons" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
"name" : "Developmental Education",
"objectStatus" : "ACTIVE"}
],
"confidentialityLevels" : null,
"permissions" : null,
"currentProgramStatusName" : "Active",
"registeredForCurrentTerm" : true
"activeAlertsCount":1,
"closedAlertsCount":2,
"paymentStatus":"Y Y Y",
"registeredTerms":"2013FA 2013SP 2013SU"
"residencyCounty":"Butler",
"f1Status":"Y",
"gender":"M",
"maritalStatus":"Single",
"ethnicity":null,
"actionPlanTaskOpenCount":4,
"actionPlanTaskClosedCount":15,
"lastActionPlanCompletedDate":1367297284590
"formattedStudentIntakeCompleteDate":null}
]
} |
Save a Person
PUT /ssp/api/1/person/{id}
...
| Code Block |
|---|
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"createdDate" : 1331269200000,
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : 1331269200000,
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"firstName" : "Sally",
"middleName" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"nonLocalAddress" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"alternateAddressLineInUse" : null,
"alternateAddressLine1" : null,
"alternateAddressLine2" : null,
"alternateAddressCity" : null,
"alternateAddressState" : null,
"alternateAddressZipCode" : null,
"alternateAddressCountry" : null,
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"studentIntakeCompleteDate" : null,
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"
"objectStatus":"ACTIVE"},},
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor",
"primaryEmailAddress" : "amy.advisor@university.edu",
"workPhone" : "(123) 456-7890",
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"
"photoUrl":"http://192.168.0.151:8080/images/0000000.png"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"actualStartTerm":"Fall",
"actualStartYear":2012,
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroups" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"name" : "Basketball Team",
"objectStatus" : "ACTIVE"}
],
"referralSources" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
"name" : "Counseling Services".
"objectStatus" : "ACTIVE"},
],
"serviceReasons" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
"name" : "Developmental Education",
"objectStatus" : "ACTIVE"}
],
"confidentialityLevels" : null,
"permissions" : null,
"currentProgramStatusName" : "Active",
"registeredForCurrentTerm" : true
"activeAlertsCount":1,
"closedAlertsCount":2,
"paymentStatus":"Y Y Y",
"registeredTerms":"2013FA 2013SP 2013SU"
"residencyCounty":"Butler",
"f1Status":"Y",
"gender":"M",
"maritalStatus":"Single",
"ethnicity":null,
"actionPlanTaskOpenCount":4,
"actionPlanTaskClosedCount":15,
"lastActionPlanCompletedDate":1367297284590
"formattedStudentIntakeCompleteDate":null}
]
} |
Returns
Person
| Code Block |
|---|
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"createdDate" : 1331269200000,
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : 1331269200000,
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"firstName" : "Sally",
"middleName" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"nonLocalAddress" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"alternateAddressLineInUse" : null,
"alternateAddressLine1" : null,
"alternateAddressLine2" : null,
"alternateAddressCity" : null,
"alternateAddressState" : null,
"alternateAddressZipCode" : null,
"alternateAddressCountry" : null,
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"studentIntakeCompleteDate" : null,
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"
"objectStatus":"ACTIVE"},},
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor",
"primaryEmailAddress" : "amy.advisor@university.edu",
"workPhone" : "(123) 456-7890",
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"
"photoUrl":"http://192.168.0.151:8080/images/0000000.png"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"actualStartTerm":"Fall",
"actualStartYear":2012,
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroups" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"name" : "Basketball Team",
"objectStatus" : "ACTIVE"}
],
"referralSources" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
"name" : "Counseling Services".
"objectStatus" : "ACTIVE"},
],
"serviceReasons" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
"name" : "Developmental Education",
"objectStatus" : "ACTIVE"}
],
"confidentialityLevels" : null,
"permissions" : null,
"currentProgramStatusName" : "Active",
"registeredForCurrentTerm" : true
"activeAlertsCount":1,
"closedAlertsCount":2,
"paymentStatus":"Y Y Y",
"registeredTerms":"2013FA 2013SP 2013SU"
"residencyCounty":"Butler",
"f1Status":"Y",
"gender":"M",
"maritalStatus":"Single",
"ethnicity":null,
"actionPlanTaskOpenCount":4,
"actionPlanTaskClosedCount":15,
"lastActionPlanCompletedDate":1367297284590
"formattedStudentIntakeCompleteDate":null}
]
} |
Delete a Person
DELETE /ssp/api/1/person/{id}
...