...
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"}, "strengthsprimaryEmailAddress" : "Good test takeramy.advisor@university.edu", "abilityToBenefit" : true, "anticipatedStartTermworkPhone" : "Fall(123) 456-7890", "anticipatedStartYearofficeLocation" : "2012",123 Benton Hall Room "studentType" :A", {"iddepartmentName" : "ce0d041d-d3ac-42a1-9085-7f744240e07e", Engineering & Applied Science"}, "namestrengths" : "EarlyGood test Alerttaker"}, "studentIntakeRequestDateabilityToBenefit" : 1331269200000true, "specialServiceGroupIdsanticipatedStartTerm" : "Fall", "anticipatedStartYear" : [{"id2012", : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}, studentType" : {"id" : "7bf36968ce0d041d-ad48d3ac-4c5f42a1-98389085-ebf495713c087f744240e07e"}, ... "name" : "Early Alert"}, ]"studentIntakeRequestDate" : 1331269200000, "referralSourceIdsspecialServiceGroupIds" : [{"id" : "a8c83fd4437f6f2b-ee337b1e-46ee47b4-8d898603-9b2956696f379e1208605c0d"}, {"id" : "55aebdf77bf36968-466bad48-49c44c5f-a08c9838-6e01eaf101d7ebf495713c08"}, ... ], "serviceReasonIdsreferralSourceIds" : [{"id" : "d95ea029a8c83fd4-90c1ee33-4be046ee-b5478d89-8054fc6914b79b2956696f37"}, {"id" : "c9ff0ce655aebdf7-aec6466b-4be249c4-b1d1a08c-9ca385edc6376e01eaf101d7"}, ... ], "currentProgramStatusNameserviceReasonIds" : "Active", [{"currentAppointmentStartDateid" : 1331269200000"d95ea029-90c1-4be0-b547-8054fc6914b7"}, "registeredForCurrentTerm" : true}, {"id" : "63d62297c9ff0ce6-bf08aec6-496f4be2-acf3b1d1-0c129d437c2b9ca385edc637"}, "createdDate" : 1331269200000, ... "createdBy" : ], {"idcurrentProgramStatusName" : "91f46e39-cea8-422b-b215-00f6bcf5d280Active", "currentAppointmentStartDate" : 1331269200000, "firstName" : "John", "registeredForCurrentTerm" : true}, {"lastNameid" : "Doe"}63d62297-bf08-496f-acf3-0c129d437c2b", "modifiedDatecreatedDate" : 1331269200000, "modifiedBycreatedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "objectStatusmodifiedDate" : "ACTIVE"1331269200000, "firstNamemodifiedBy" : "Bill", {"middleInitialid" : null,"91f46e39-cea8-422b-b215-00f6bcf5d280", "lastNamefirstName" : "SmithJohn", "birthDate" : null, "primaryEmailAddresslastName" : "bill.smith@university.eduDoe"}, "secondaryEmailAddressobjectStatus" : null"ACTIVE", "usernamefirstName" : "bill.smithBill", "userIdmiddleInitial" : null, "homePhonelastName" : "987-65-4321Smith", "workPhonebirthDate" : null, "cellPhoneprimaryEmailAddress" : null"bill.smith@university.edu", "addressLine1secondaryEmailAddress" : "110 North Front Street"null, "addressLine2username" : null"bill.smith", "cityuserId" : "Dayton"null, "statehomePhone" : "OH987-65-4321", "zipCodeworkPhone" : "45402"null, "photoUrlcellPhone" : null, "schoolIdaddressLine1" : null"110 North Front Street", "enabledaddressLine2" : falsenull, "coachcity" : "Dayton", {"idstate" : "91f46e39-cea8-422b-b215-00f6bcf5d280OH", "firstNamezipCode" : "Amy45402", "lastNamephotoUrl" : "Advisor"}null, "strengthsschoolId" : "Great communication skills"null, "abilityToBenefitenabled" : nullfalse, "anticipatedStartTermcoach" : "Spring", {"anticipatedStartYearid" : "201391f46e39-cea8-422b-b215-00f6bcf5d280", "studentTypefirstName" : "Amy", {"idlastName" : "e34b0d14-f6f0-4adb-85c6-694de9fc0685Advisor", "nameprimaryEmailAddress" : "Transferamy.advisor@university.edu"}, "studentIntakeRequestDateworkPhone" : null"(123) 456-7890", "specialServiceGroupIds" : "officeLocation" : "123 Benton Hall Room [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}A", {"iddepartmentName" : "7bf36968-ad48-4c5f-9838-ebf495713c08Engineering & Applied Science"}, "strengths" : "Great ... communication skills", "abilityToBenefit" : ]null, "referralSourceIdsanticipatedStartTerm" : "Spring", [{"idanticipatedStartYear" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},2013", "studentType" : {"id" : "55aebdf7e34b0d14-466bf6f0-49c44adb-a08c85c6-6e01eaf101d7694de9fc0685"}, ... "name" : "Transfer"}, "studentIntakeRequestDate" : ]null, "serviceReasonIdsspecialServiceGroupIds" : [{"id" : "d95ea029437f6f2b-90c17b1e-4be047b4-b5478603-8054fc6914b79e1208605c0d"}, {"id" : "c9ff0ce67bf36968-aec6ad48-4be24c5f-b1d19838-9ca385edc637ebf495713c08"}, ... ], "currentProgramStatusNamereferralSourceIds" : "Non-participating", "currentAppointmentStartDate" : null [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"}, {"registeredForCurrentTermid" : true"55aebdf7-466b-49c4-a08c-6e01eaf101d7"}, ... ] } |
Get All Persons Who Are Coaches
This method calls the corresponding uPlatform API to obtain those individuals assigned the Coach group.
GET /ssp/api/1/person/coach
Security
PERSON_READ
...
Returns
Code Block |
---|
{"success" : "true", "results" : "100", "rows" : [, "serviceReasonIds" : [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}, {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"}, ... ], "currentProgramStatusName" : "Non-participating", "currentAppointmentStartDate" : null, "registeredForCurrentTerm" : true}, ... ] } |
Get All Persons Who Are Coaches
This method calls the corresponding uPlatform API to obtain those individuals assigned the Coach group.
GET /ssp/api/1/person/coach
Security
PERSON_READ
Returns
List<PersonLiteTO>
Returns
Code Block |
---|
{"success" : "true", "results" : "100", "rows" : [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41", "firstName" : "Camden", "lastName" : "Coach", "primaryEmailAddress" : "camden.coach@university.edu", "workPhone" : "(123) 313-2837", "officeLocation" : "Stiller Hall Room 132", "departmentName" : "Management & Accounting"}, {"id" : "58ba5ee363d62297-734ebf08-4ae9496f-b9c5acf3-943774b4de410c129d437c2b", "firstName" : "CamdenChristina", "lastName" : "Coach"},", "primaryEmailAddress" : "christina.coach@university.edu", {"idworkPhone" : "63d62297-bf08-496f-acf3-0c129d437c2b(323) 322-2907", "firstNameofficeLocation" : "ChristinaKrieger Hall Room 9", "lastNamedepartmentName" : "CoachPsychology"}, ... ] } |
Get a Person
GET /ssp/api/1/person/{id}
...
Code Block |
---|
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41", "createdDate-943774b4de41", "createdDate" : 1331269200000, "createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : 1331269200000, "createdBymodifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDateobjectStatus" : 1331269200000"ACTIVE", "modifiedByfirstName" : "Sally", "middleInitial" : null, { "idlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280Student", "birthDate" : null, "firstNameprimaryEmailAddress" : "Johnsally.student@university.edu", "secondaryEmailAddress" : null, "lastNameusername" : "Doesally.student"}, "userId" "objectStatus: null, "homePhone" : "ACTIVE123-456-7890", "firstNameworkPhone" : "Sally"null, "middleInitialcellPhone" : null, "lastNameaddressLine1" : "Student444 West Third Street", "birthDateaddressLine2" : null, "primaryEmailAddresscity" : "sally.student@university.eduDayton", "secondaryEmailAddressstate" : null"OH", "usernamezipCode" : "sally.student45402", "userIdphotoUrl" : null, "homePhoneschoolId" : "123-456-7890"null, "workPhoneenabled" : nullfalse, "cellPhonecoach" : null, "addressLine1" : "444 West Third Street", "addressLine2" : null, "city" : "Dayton", "state{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "OHAmy", "zipCode" : "45402", "photoUrllastName" : null"Advisor", "schoolId" : null, "enabledprimaryEmailAddress" : false, "coachamy.advisor@university.edu", : {"idworkPhone" : "91f46e39-cea8-422b-b215-00f6bcf5d280(123) 456-7890", "firstNameofficeLocation" : "Amy123 Benton Hall Room A", "lastNamedepartmentName" : "Advisor "Engineering & Applied Science"}, "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"}, ... ], "currentProgramStatusName" : "Active", "currentAppointmentStartDate" : 1331269200000, "registeredForCurrentTerm" : true } |
...
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", "primaryEmailAddress" : "amy.advisor@university.edu", "workPhone" : "Amy(123) 456-7890", "officeLocation" : "123 Benton Hall Room A", "lastNamedepartmentName" : "AdvisorEngineering & Applied Science"}, "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"}, ... ], "currentProgramStatusName" : "Active", "currentAppointmentStartDate" : 1331269200000, "registeredForCurrentTerm" : null } |
...
Code Block |
---|
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41", "createdDate-943774b4de41", "createdDate" : 1331269200000, "createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : 1331269200000, "createdBymodifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDateobjectStatus" : 1331269200000"ACTIVE", "modifiedByfirstName" : "Sally", "middleInitial" : null, { "idlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280Student", "birthDate" : null, "firstNameprimaryEmailAddress" : "Johnsally.student@university.edu", "secondaryEmailAddress" : null, "lastNameusername" : "Doesally.student"}, "userId" "objectStatus: null, "homePhone" : "ACTIVE123-456-7890", "firstNameworkPhone" : "Sally"null, "middleInitialcellPhone" : null, "lastNameaddressLine1" : "Student444 West Third Street", "birthDateaddressLine2" : null, "primaryEmailAddresscity" : "sally.student@university.eduDayton", "secondaryEmailAddressstate" : null"OH", "usernamezipCode" : "sally.student45402", "userIdphotoUrl" : null, "homePhoneschoolId" : "123-456-7890"null, "workPhoneenabled" : nullfalse, "cellPhonecoach" : null, "addressLine1" : "444 West Third Street", "addressLine2" : null, "city" : "Dayton", "state{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "OHAmy", "zipCode" : "45402", "photoUrllastName" : null"Advisor", "schoolId" : null, "enabledprimaryEmailAddress" : false, "coachamy.advisor@university.edu", : {"idworkPhone" : "91f46e39-cea8-422b-b215-00f6bcf5d280(123) 456-7890", "firstNameofficeLocation" : "Amy123 Benton Hall Room A", "lastNamedepartmentName" : "Advisor "Engineering & Applied Science"}, "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"}, ... ], "currentProgramStatusName" : "Active", "currentAppointmentStartDate" : 1331269200000, "registeredForCurrentTerm" : true } |
...
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", "primaryEmailAddress" : "amy.advisor@university.edu", "workPhone" : "Amy(123) 456-7890", "officeLocation" : "123 Benton Hall Room A", "lastNamedepartmentName" : "AdvisorEngineering & Applied Science"}, "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"}, ... ], "currentProgramStatusName" : "Active", "currentAppointmentStartDate" : 1331269200000, "registrationStatusForCurrentTerm" : true } |
...
Code Block |
---|
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41", "createdDate-b9c5-943774b4de41", "createdDate" : 1331269200000, "createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : 1331269200000, "createdBymodifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDateobjectStatus" : 1331269200000"ACTIVE", "modifiedByfirstName" : "Sally", "middleInitial" : {"idnull, "lastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280Student", "birthDate" : null, "firstNameprimaryEmailAddress" : "Johnsally.student@university.edu", "secondaryEmailAddress" : null, "lastNameusername" : "Doesally.student"}, "objectStatususerId" : "ACTIVE"null, "firstNamehomePhone" : "Sally123-456-7890", "middleInitialworkPhone" : null, "lastNamecellPhone" : "Student"null, "birthDateaddressLine1" : null,"444 West "primaryEmailAddress" : "sally.student@university.edu"Third Street", "secondaryEmailAddressaddressLine2" : null, "usernamecity" : "sally.studentDayton", "userIdstate" : null"OH", "homePhonezipCode" : "123-456-789045402", "workPhonephotoUrl" : null, "cellPhoneschoolId" : null, "addressLine1enabled" : "444 West Third Street", "addressLine2false, "coach" : {"id" : null"91f46e39-cea8-422b-b215-00f6bcf5d280", "city" : "Dayton", "statefirstName" : "OHAmy", "zipCode" : "45402", "photoUrllastName" : null"Advisor", "schoolId" : null, "enabledprimaryEmailAddress" : false, "coachamy.advisor@university.edu", : {"idworkPhone" : "91f46e39-cea8-422b-b215-00f6bcf5d280(123) 456-7890", "firstNameofficeLocation" : "Amy123 Benton Hall Room A", "lastNamedepartmentName" : "AdvisorEngineering & Applied Science"}, "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"}, ... ], "currentProgramStatusName" : "Active", "currentAppointmentStartDate" : 1331269200000, "registeredForCurrentTerm" : true } |
...