...
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", "middleInitial" : null, "lastName" : "Student", "birthDate" : null, "primaryEmailAddress" : "sally.student@university.edu", "secondaryEmailAddress" : null, "username" : "sally.student", "userId" : null, "homePhone" : "123-456-7890", "workPhone" : null, "cellPhone" : null, "addressLine1" : "444 West Third Street", "addressLine2" : null, "city" : "Dayton", "state" : "OH", "zipCode" : "45402", "photoUrl" : null, "schoolId" : null, "enabled" : false, "coach" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "Amy", "lastName" : "Advisor"}, "strengths" : "Good test taker", "abilityToBenefit" : true, "anticipatedStartTerm" : "Fall", "anticipatedStartYear" : "2012", "studentType" : {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e", "name" : "Early Alert"}, "studentIntakeRequestDate" : 1331269200000, "specialServiceGroupIds" : [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}, {"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}, ... ], "referralSourceIds" : [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"}, {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"}, ... ], "serviceReasonIds" : [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}, {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"}, ... ], "programStatus" : {"id" : "acf7d721-196f-4353-9508-fe86c61e3c1d", "name" : "Active"}, "registrationStatusForCurrentTerm" : "Registered"}, {"id" : "63d62297-bf08-496f-acf3-0c129d437c2b", "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" : "Bill", "middleInitial" : null, "lastName" : "Smith", "birthDate" : null, "primaryEmailAddress" : "bill.smith@university.edu", "secondaryEmailAddress" : null, "username" : "bill.smith", "userId" : null, "homePhone" : "987-65-4321", "workPhone" : null, "cellPhone" : null, "addressLine1" : "110 North Front Street", "addressLine2" : null, "city" : "Dayton", "state" : "OH", "zipCode" : "45402", "photoUrl" : null, "schoolId" : null, "enabled" : false, "coach" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "Amy", "lastName" : "Advisor"}, "strengths" : "Great communication skills", "abilityToBenefit" : null, "anticipatedStartTerm" : "Spring", "anticipatedStartYear" : "2013", "studentType" : {"id" : "e34b0d14-f6f0-4adb-85c6-694de9fc0685", "name" : "Transfer"}, "studentIntakeRequestDate" : null, "specialServiceGroupIds" : [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}, {"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}, ... ], "referralSourceIds" : [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"}, {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"}, ... ], "serviceReasonIds" : [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}, {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"}, ... ], "programStatus" : {"id" : "e8f6a45b-79ce-4687-831c-ca5f190dddc3", "name" : "Non-participating"}, "registrationStatusForCurrentTerm" : "Registered"}, ... ] } |
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",
"middleInitial" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"userId" : null,
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"},
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroupIds" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
{"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
...
],
"referralSourceIds" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
{"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
...
],
"serviceReasonIds" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
{"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
...
],
"programStatus" :
{"id" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"name" : "Active"},
"registrationStatusForCurrentTerm" : "Registered"
} |
Create a Person
POST /ssp/api/1/person
...
Code Block |
---|
{"firstName" : "Sally",
"middleInitial" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"userId" : null,
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"},
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroupIds" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
{"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
...
],
"referralSourceIds" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
{"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
...
],
"serviceReasonIds" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
{"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
...
],
"programStatus" :
{"id" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"name" : "Active"},
"registrationStatusForCurrentTerm" : 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", "middleInitial" : null, "lastName" : "Student", "birthDate" : null, "primaryEmailAddress" : "sally.student@university.edu", "secondaryEmailAddress" : null, "username" : "sally.student", "userId" : null, "homePhone" : "123-456-7890", "workPhone" : null, "cellPhone" : null, "addressLine1" : "444 West Third Street", "addressLine2" : null, "city" : "Dayton", "state" : "OH", "zipCode" : "45402", "photoUrl" : null, "schoolId" : null, "enabled" : false, "coach" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "Amy", "lastName" : "Advisor"}, "strengths" : "Good test taker", "abilityToBenefit" : true, "anticipatedStartTerm" : "Fall", "anticipatedStartYear" : "2012", "studentType" : {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e", "name" : "Early Alert"}, "studentIntakeRequestDate" : 1331269200000, "specialServiceGroupIds" : [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}, {"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}, ... ], "referralSourceIds" : [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"}, {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"}, ... ], "serviceReasonIds" : [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}, {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"}, ... ], "programStatus" : {"id" : "acf7d721-196f-4353-9508-fe86c61e3c1d", "name" : "Active"}, "registrationStatusForCurrentTerm" : "Registered" } |
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",
"middleInitial" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"userId" : null,
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"},
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroupIds" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
{"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
...
],
"referralSourceIds" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
{"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
...
],
"serviceReasonIds" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
{"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
...
],
"programStatus" :
{"id" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"name" : "Active"},
"registrationStatusForCurrentTerm" : "Registered"
} |
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",
"middleInitial" : null,
"lastName" : "Student",
"birthDate" : null,
"primaryEmailAddress" : "sally.student@university.edu",
"secondaryEmailAddress" : null,
"username" : "sally.student",
"userId" : null,
"homePhone" : "123-456-7890",
"workPhone" : null,
"cellPhone" : null,
"addressLine1" : "444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor"},
"strengths" : "Good test taker",
"abilityToBenefit" : true,
"anticipatedStartTerm" : "Fall",
"anticipatedStartYear" : "2012",
"studentType" :
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"name" : "Early Alert"},
"studentIntakeRequestDate" : 1331269200000,
"specialServiceGroupIds" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
{"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
...
],
"referralSourceIds" :
[{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
{"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
...
],
"serviceReasonIds" :
[{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
{"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
...
],
"programStatus" :
{"id" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"name" : "Active"},
"registrationStatusForCurrentTerm" : "Registered"
} |
Delete a Person
DELETE /ssp/api/1/person/{id}
...