...
| 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",
]
} |
Get All Persons Who Are Coaches
This method calls the corresponding uPlatform API to obtain those individuals assigned the Coach group.
| Info |
|---|
For performance reasons, this result set is populated by a background job that by default runs every 5m. The background job and known issues with user attribute caching in uPortal affect how quickly the coach list in uPortal is updated. |
GET /ssp/api/1/person/coach
Security
PERSON_READ
...
Returns
| Code Block |
|---|
{"success" : "true", "results" : "100", "rows" : [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41", "firstName" : "Camden" "f1Status":"Y", "gender":"M", "maritalStatus":"Single", "ethnicity":null, "actionPlanTaskOpenCount":4, "actionPlanTaskClosedCount":15, "lastActionPlanCompletedDate":1367297284590} ] } |
Get All Persons Who Are Coaches
This method calls the corresponding uPlatform API to obtain those individuals assigned the Coach group.
| Info |
|---|
For performance reasons, this result set is populated by a background job that by default runs every 5m. The background job and known issues with user attribute caching in uPortal affect how quickly the coach list in uPortal is updated. |
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"},
{"id" : "63d62297-bf08-496f-acf3-0c129d437c2b",
"firstName" : "Christina",
"lastName" : "Coach"},
...
]
} |
Get a Person
GET /ssp/api/1/person/{id}
Security
PERSON_READ
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}
]
} |
Get a Person by School ID
Selects a single person by their school id. The school id is typically the person's unique institutional id stored in the ERP system.
GET /ssp/api/1/person/bySchoolId/{schoolId}
Security
PERSON_READ
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"}, ], "lastNameserviceReasons" : "Coach"}, [{"id" : "63d62297d95ea029-bf0890c1-496f4be0-acf3b547-0c129d437c2b8054fc6914b7"}, "firstNamename" : "ChristinaDevelopmental Education", "lastNameobjectStatus" : "CoachACTIVE"}, ... ], ] } |
Get a Person
GET /ssp/api/1/person/{id}
Security
PERSON_READ
Returns
Person
| Code Block |
|---|
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41", "createdDateconfidentialityLevels" : 1331269200000null, "createdBy" : {"idpermissions" : "91f46e39-cea8-422b-b215-00f6bcf5d280",null, "firstNamecurrentProgramStatusName" : "JohnActive", "lastNameregisteredForCurrentTerm" : "Doe"},true "modifiedDate" : 1331269200000, "modifiedByactiveAlertsCount" :1, {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280"closedAlertsCount":2, "firstNamepaymentStatus":"Y :Y "JohnY", "registeredTerms"lastName:"2013FA :2013SP 2013SU"Doe"}, "objectStatusresidencyCounty" : "ACTIVEButler", "firstNamef1Status" : "SallyY", "middleInitialgender" : null,"M", "lastNamemaritalStatus" : "StudentSingle", "birthDateethnicity" : null, "primaryEmailAddressactionPlanTaskOpenCount" : "sally.student@university.edu",4, "secondaryEmailAddressactionPlanTaskClosedCount" :15, null, "usernamelastActionPlanCompletedDate" : "sally.student", "homePhone:1367297284590} ] } |
Create a Person
POST /ssp/api/1/person
Security
PERSON_WRITE
Note
Properties currentAppointmentStartDate and currentProgramStatusName are helper properties and are not saved if specified. Call the respective Person Appointment and Person Program Status services to save these entries.
Sample Post
| Code Block |
|---|
{ "firstName" : "123-456-7890Sally", "workPhone" : null, "cellPhonemiddleName" : null, "nonLocalAddress" : null, "addressLine1lastName" : "Student"444, West Third Street", "addressLine2birthDate" : null, "cityprimaryEmailAddress" : "Daytonsally.student@university.edu", "statesecondaryEmailAddress" : "OH"null, "zipCodeusername" : "45402sally.student", "alternateAddressLineInUsehomePhone" : null"123-456-7890", "alternateAddressLine1" : null, "alternateAddressLine2workPhone" : null, "alternateAddressCity" : null, "alternateAddressStatecellPhone" : null, "alternateAddressZipCode" : null, "alternateAddressCountrynonLocalAddress" : null, "photoUrl" : null, "schoolIdaddressLine1" : null,"444 West Third Street", "enabled" : false, "studentIntakeCompleteDateaddressLine2" : null, "coach" : {"idcity" : "91f46e39-cea8-422b-b215-00f6bcf5d280Dayton", "firstNamestate" : "AmyOH", "lastNamezipCode" : "Advisor45402", "primaryEmailAddressalternateAddressLineInUse" : "amy.advisor@university.edu"null, "workPhonealternateAddressLine1" : "(123) 456-7890",null, "officeLocationalternateAddressLine2" : "123 Benton Hall Room A",null, "departmentNamealternateAddressCity" : "Engineering & Applied Science"},null, "strengthsalternateAddressState" : "Good test taker",null, "abilityToBenefitalternateAddressZipCode" : truenull, "anticipatedStartTermalternateAddressCountry" : "Fall",null, "anticipatedStartYearphotoUrl" : "2012"null, "actualStartTerm":"Fall", "actualStartYearschoolId" :2012 null, "studentType" : {"idenabled" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",false, "namestudentIntakeCompleteDate" : "Early Alert"}, null, "studentIntakeRequestDatestudentType" : 1331269200000, "specialServiceGroups" : [{"id" : "437f6f2bce0d041d-7b1ed3ac-47b442a1-86039085-9e1208605c0d7f744240e07e", "name" : "BasketballEarly Team", Alert" "objectStatus" : "ACTIVE"},} , ], "referralSourcescoach" : [{"id" : "a8c83fd491f46e39-ee33cea8-46ee-8d89-9b2956696f37", "name" : "Counseling Services". "objectStatus" : "ACTIVE"}422b-b215-00f6bcf5d280", ], "serviceReasonsfirstName" : "Amy", [{"idlastName" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}Advisor", "name" : "Developmental Education", "objectStatusprimaryEmailAddress" : "ACTIVE"}amy.advisor@university.edu", ], "confidentialityLevelsworkPhone" : null "(123) 456-7890", "permissions" : null, "currentProgramStatusNameofficeLocation" : "Active123 Benton Hall Room A", "registeredForCurrentTerm" : true "activeAlertsCount":1, "closedAlertsCount":2, "paymentStatusdepartmentName" : "YEngineering & YApplied YScience", "registeredTermsphotoUrl":"2013FA 2013SP 2013SU" } |
Get a Person by School ID
Selects a single person by their school id. The school id is typically the person's unique institutional id stored in the ERP system.
GET /ssp/api/1/person/bySchoolId/{schoolId}
Security
PERSON_READ
Returns
Person
| Code Block |
|---|
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41", "createdDate" : 1331269200000, "createdBy" :http://192.168.0.151:8080/images/0000000.png"}, "strengths" : "Good test taker", "abilityToBenefit" : true, {"idanticipatedStartTerm" : "91f46e39-cea8-422b-b215-00f6bcf5d280Fall", "firstNameanticipatedStartYear" : "John2012", "lastNameactualStartTerm" : "DoeFall"}, "modifiedDate" : 1331269200000, "modifiedByactualStartYear" :2012, {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280"studentIntakeRequestDate" : 1331269200000, "firstNamespecialServiceGroups" : "John", [{"lastNameid" : "Doe"}437f6f2b-7b1e-47b4-8603-9e1208605c0d", "objectStatusname" : "ACTIVEBasketball Team", "firstNameobjectStatus" : "SallyACTIVE",} "middleInitial" : null, "lastName" : "Student"], "birthDate" : null, "primaryEmailAddressreferralSources" : "sally.student@university.edu", "secondaryEmailAddress" : null, "username" : "sally.student", [{"homePhoneid" : "123-456-7890",a8c83fd4-ee33-46ee-8d89-9b2956696f37", "workPhonename" : null,"Counseling Services"cellPhone". : null, "nonLocalAddressobjectStatus" : null"ACTIVE"}, "addressLine1" : "444 West Third Street", "addressLine2" : null], "city" : "Dayton", "stateserviceReasons" : "OH", "zipCode" : "45402", "alternateAddressLineInUse" : null, [{"alternateAddressLine1id" : null, "alternateAddressLine2" : null,"d95ea029-90c1-4be0-b547-8054fc6914b7"}, "alternateAddressCityname" : null,"Developmental Education"alternateAddressState", : null, "alternateAddressZipCodeobjectStatus" : null, "alternateAddressCountryACTIVE"} : null, "photoUrl" : null, "schoolId" : null], "studentIntakeCompleteDate" : null, "enabledconfidentialityLevels" : falsenull, "coach" : {"idpermissions" : "91f46e39-cea8-422b-b215-00f6bcf5d280",null, "firstNamecurrentProgramStatusName" : "AmyActive", "lastNameregisteredForCurrentTerm" : "Advisor", true "primaryEmailAddress" : "amy.advisor@university.edu"activeAlertsCount":1, "workPhoneclosedAlertsCount" : "(123) 456-7890",:2, "officeLocationpaymentStatus" : "123Y Benton Hall Room AY Y", "departmentNameregisteredTerms" : "Engineering2013FA &2013SP Applied Science"},2013SU" "strengthsresidencyCounty" : "Good test takerButler", "abilityToBenefitf1Status" : true,"Y", "anticipatedStartTermgender" : "FallM", "anticipatedStartYearmaritalStatus" : "2012Single", "actualStartTermethnicity":"Fall",null, "actionPlanTaskOpenCount":4, "actualStartYearactionPlanTaskClosedCount":201215, "studentTypelastActionPlanCompletedDate" :1367297284590} ] } |
Returns
Person
| Code Block |
|---|
{"id" : "ce0d041d58ba5ee3-d3ac734e-42a14ae9-9085b9c5-7f744240e07e943774b4de41",
"namecreatedDate" : "Early Alert"},1331269200000,
"studentIntakeRequestDate" : 1331269200000, "specialServiceGroupscreatedBy" :
[{"id" : "437f6f2b91f46e39-7b1ecea8-47b4422b-8603b215-9e1208605c0d00f6bcf5d280",
"namefirstName" : "Basketball TeamJohn",
"objectStatuslastName" : "ACTIVEDoe"},
"modifiedDate" : ]1331269200000,
"referralSourcesmodifiedBy" :
[{"id" : "a8c83fd491f46e39-ee33cea8-46ee422b-8d89b215-9b2956696f3700f6bcf5d280",
"namefirstName" : "Counseling Services".
John",
"objectStatuslastName" : "ACTIVEDoe"},
],
"serviceReasons"objectStatus" : "ACTIVE",
[{"idfirstName" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},Sally",
"middleName" : null,
"namelastName" : "Developmental EducationStudent",
"birthDate" : null,
"objectStatusprimaryEmailAddress" : "ACTIVE"}sally.student@university.edu",
"secondaryEmailAddress" : ],null,
"confidentialityLevelsusername" : null"sally.student",
"permissions" : null, "currentProgramStatusNamehomePhone" : "Active123-456-7890",
"registeredForCurrentTerm" : true "activeAlertsCountworkPhone" :1 null,
"closedAlertsCount":2, "paymentStatuscellPhone" :"Y Ynull,
Y", "registeredTerms":"2013FA 2013SP 2013SU"
} |
Create a Person
POST /ssp/api/1/person
Security
PERSON_WRITE
Note
Properties currentAppointmentStartDate and currentProgramStatusName are helper properties and are not saved if specified. Call the respective Person Appointment and Person Program Status services to save these entries.
Sample Post
| Code Block |
|---|
{"firstName "nonLocalAddress" : null, "addressLine1" : "Sally444 West Third Street", "middleInitialaddressLine2" : null, "lastNamecity" : "StudentDayton", "birthDatestate" : null"OH", "primaryEmailAddresszipCode" : "sally.student@university.edu",45402", "alternateAddressLineInUse" : null, "secondaryEmailAddressalternateAddressLine1" : null, "usernamealternateAddressLine2" : "sally.student"null, "homePhonealternateAddressCity" : "123-456-7890"null, "workPhonealternateAddressState" : null, "cellPhonealternateAddressZipCode" : null, "nonLocalAddressalternateAddressCountry" : null, "addressLine1photoUrl" : "444 West Third Street",null, "addressLine2schoolId" : null, "city" : "Dayton", "stateenabled" : "OH"false, "zipCode" : "45402", "alternateAddressLineInUsestudentIntakeCompleteDate" : null, "alternateAddressLine1studentType" : null, "alternateAddressLine2" : null, {"alternateAddressCityid" : null,"ce0d041d-d3ac-42a1-9085-7f744240e07e", "alternateAddressState" : null, "alternateAddressZipCode" : null, "alternateAddressCountryname" : null,"Early "photoUrl" : null, "schoolId" : null,Alert" "enabledobjectStatus" : false,"ACTIVE"},}, "studentIntakeCompleteDate" : null, "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", "actualStartTermanticipatedStartYear" :"Fall", "actualStartYear2012":2012, "studentType" : {"idactualStartTerm" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"Fall", "nameactualStartYear":2012, : "Early Alert"}, "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" : nulltrue "activeAlertsCount":1, "closedAlertsCount":2, "paymentStatus":"Y Y Y", "registeredTerms":"2013FA 2013SP 2013SU" "residencyCounty":"Butler", "f1Status":"Y", " } |
Returns
Person
| Code Block |
|---|
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41", "createdDate" : 1331269200000, "createdBy" : gender":"M", "maritalStatus":"Single", "ethnicity":null, "actionPlanTaskOpenCount":4, "actionPlanTaskClosedCount":15, "lastActionPlanCompletedDate":1367297284590} ] } |
Save a Person
PUT /ssp/api/1/person/{id}
Security
PERSON_WRITE
Note
Properties currentAppointmentStartDate and currentProgramStatusName are helper properties and are not saved if specified. Call the respective Person Appointment and Person Program Status services to save these entries.
Sample Post
| Code Block |
|---|
{"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
"firstNamecreatedDate" : "John"1331269200000,
"lastNamecreatedBy" :
"Doe"}, "modifiedDate" : 1331269200000, "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastNamefirstName" : "DoeJohn"},
"objectStatus" : "ACTIVE", "firstName" : "Sally", "middleInitial" : null,
"lastName" : "StudentDoe"},
"birthDate" : null, "primaryEmailAddress" : "sally.student@university.edu", "secondaryEmailAddressmodifiedDate" : null1331269200000,
"usernamemodifiedBy" : "sally.student",
{"homePhoneid" : "123-456-789091f46e39-cea8-422b-b215-00f6bcf5d280",
"workPhone" : null, "cellPhone" : null, "addressLine1firstName" : "John"444,
West Third Street", "addressLine2" : null, "citylastName" : "DaytonDoe"},
"state" : "OH", "zipCodeobjectStatus" : "45402ACTIVE",
"nonLocalAddress" : null, "alternateAddressLineInUsefirstName" : null"Sally",
"alternateAddressLine1" : null, "alternateAddressLine2middleName" : null,
"alternateAddressCity" : null, "alternateAddressStatelastName" : null"Student",
"alternateAddressZipCode" : null, "alternateAddressCountrybirthDate" : null,
"photoUrl" : null, "schoolIdprimaryEmailAddress" : null,"sally.student@university.edu",
"enabled" : false, "studentIntakeCompleteDatesecondaryEmailAddress" : null,
"coach" : {"idusername" : "91f46e39-cea8-422b-b215-00f6bcf5d280sally.student",
"firstNamehomePhone" : "Amy123-456-7890",
"lastNameworkPhone" : "Advisor"null,
"primaryEmailAddress" : "amy.advisor@university.edu"cellPhone" : null,
"workPhonenonLocalAddress" : "(123) 456-7890",null,
"officeLocationaddressLine1" : "123444 BentonWest HallThird Room AStreet",
"departmentNameaddressLine2" : null,
"Engineering & Applied Science"}, "strengthscity" : "Good test takerDayton",
"abilityToBenefit" : true, "anticipatedStartTermstate" : "FallOH",
"anticipatedStartYearzipCode" : "201245402",
"actualStartTermalternateAddressLineInUse" :"Fall" null,
"actualStartYearalternateAddressLine1" :2012 null,
"studentType" : {"idalternateAddressLine2" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"null,
"namealternateAddressCity" : "Early Alert"},null,
"studentIntakeRequestDate" : 1331269200000, "specialServiceGroupIdsalternateAddressState" : null,
[{"idalternateAddressZipCode" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"null,
"alternateAddressCountry" : null,
"namephotoUrl" : "Basketball Team"null,
"schoolId" : null,
"objectStatusenabled" : "ACTIVE"}false,
"studentIntakeCompleteDate" : null,
], "referralSourceIdsstudentType" :
[{"id" : "a8c83fd4ce0d041d-ee33d3ac-46ee42a1-8d899085-9b2956696f377f744240e07e",
"name" : "CounselingEarly ServicesAlert".
"objectStatus" : "ACTIVE"},},
],
"serviceReasonIds"coach" :
[{"id" : "d95ea02991f46e39-90c1cea8-4be0422b-b547b215-8054fc6914b700f6bcf5d280"},
"namefirstName" : "Developmental EducationAmy",
"objectStatuslastName" : "ACTIVE"}
]Advisor",
"confidentialityLevels" : null, "permissions" : null,
"currentProgramStatusName" : "Active",
"registeredForCurrentTerm" : true "activeAlertsCountprimaryEmailAddress" :1, "closedAlertsCount":2,
"paymentStatus":"Y Y Y",
"registeredTerms":"2013FA 2013SP 2013SU"
} |
Save a Person
PUT /ssp/api/1/person/{id}
Security
PERSON_WRITE
Note
Properties currentAppointmentStartDate and currentProgramStatusName are helper properties and are not saved if specified. Call the respective Person Appointment and Person Program Status services to save these entries.
Sample Post
| Code Block |
|---|
{"idamy.advisor@university.edu", "workPhone" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41(123) 456-7890", "createdDate "officeLocation" : 1331269200000 "123 Benton Hall Room A", "createdBy" : {"iddepartmentName" : "91f46e39-cea8-422b-b215-00f6bcf5d280", Engineering & Applied Science" "firstNamephotoUrl" : "John","http://192.168.0.151:8080/images/0000000.png"}, "lastNamestrengths" : "Doe"} "Good test taker", "modifiedDateabilityToBenefit" : 1331269200000true, "modifiedBy" : {"idanticipatedStartTerm" : "91f46e39-cea8-422b-b215-00f6bcf5d280Fall", "firstNameanticipatedStartYear" : "John2012", "lastNameactualStartTerm" : "DoeFall"}, "objectStatus" : "ACTIVEactualStartYear":2012, "firstNamestudentIntakeRequestDate" : "Sally",1331269200000, "middleInitialspecialServiceGroups" : null, "lastName" : "Student", "birthDate" : null, [{"primaryEmailAddressid" : "sally.student@university.edu437f6f2b-7b1e-47b4-8603-9e1208605c0d", "secondaryEmailAddress" : null, "usernamename" : "sally.studentBasketball Team", "homePhoneobjectStatus" : "123-456-7890",ACTIVE"} "workPhone" : null, "cellPhone" : null], "nonLocalAddress" : null, "addressLine1referralSources" : "444 West Third Street", "addressLine2" : null, [{"cityid" : "Daytona8c83fd4-ee33-46ee-8d89-9b2956696f37", "statename" : "OH",Counseling Services". "zipCodeobjectStatus" : "45402ACTIVE"}, "alternateAddressLineInUse" : null ], "alternateAddressLine1serviceReasons" : null, "alternateAddressLine2" : null, [{"alternateAddressCityid" : null"d95ea029-90c1-4be0-b547-8054fc6914b7"}, "alternateAddressStatename" : "Developmental nullEducation", "alternateAddressZipCodeobjectStatus" : null, "alternateAddressCountryACTIVE"} : null, "photoUrl" : null, "schoolId" : null], "enabled" : false, "studentIntakeCompleteDateconfidentialityLevels" : null, "coach" : {"idpermissions" : "91f46e39-cea8-422b-b215-00f6bcf5d280"null, "firstNamecurrentProgramStatusName" : "AmyActive", "lastNameregisteredForCurrentTerm" : true "Advisor", "primaryEmailAddressactiveAlertsCount" : "amy.advisor@university.edu",1, "workPhoneclosedAlertsCount" :2, "(123) 456-7890", "officeLocationpaymentStatus" : "123Y Benton Hall Room AY Y", "departmentNameregisteredTerms" : "Engineering2013FA &2013SP Applied Science"},2013SU" "strengthsresidencyCounty" : "Good test takerButler", "abilityToBenefitf1Status" : true,"Y", "anticipatedStartTermgender" : "FallM", "anticipatedStartYearmaritalStatus" : "2012Single", "actualStartTermethnicity":"Fall",null, "actionPlanTaskOpenCount":4, "actualStartYearactionPlanTaskClosedCount":201215, "studentTypelastActionPlanCompletedDate" :1367297284590} ] } |
Returns
Person
| Code Block |
|---|
{"id" : "ce0d041d58ba5ee3-d3ac734e-42a14ae9-9085b9c5-7f744240e07e943774b4de41",
"namecreatedDate" : "Early Alert"},1331269200000,
"studentIntakeRequestDate" : 1331269200000, "specialServiceGroupscreatedBy" :
[{"id" : "437f6f2b91f46e39-7b1ecea8-47b4422b-8603b215-9e1208605c0d00f6bcf5d280",
"namefirstName" : "Basketball TeamJohn",
"objectStatuslastName" : "ACTIVEDoe"},
"modifiedDate" : ]1331269200000,
"referralSourcesmodifiedBy" :
[{"id" : "a8c83fd491f46e39-ee33cea8-46ee422b-8d89b215-9b2956696f3700f6bcf5d280",
"namefirstName" : "Counseling ServicesJohn".,
"objectStatuslastName" : "ACTIVEDoe"},
], "serviceReasonsobjectStatus" :
"ACTIVE",
[{"idfirstName" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
Sally",
"middleName" : null,
"namelastName" : "Developmental EducationStudent",
"birthDate" : null,
"objectStatusprimaryEmailAddress" : "ACTIVE"}
sally.student@university.edu",
],
"confidentialityLevelssecondaryEmailAddress" : null,
"permissions" : null, "currentProgramStatusNameusername" : "Activesally.student",
"registrationStatusForCurrentTerm" : true } |
Returns
Person
| Code Block |
|---|
{"id"homePhone" : "58ba5ee3123-734e-4ae9-b9c5-943774b4de41456-7890", "createdDateworkPhone" : 1331269200000null, "createdBy" : {"idcellPhone" : "91f46e39-cea8-422b-b215-00f6bcf5d280"null, "firstNamenonLocalAddress" : "John"null, "lastNameaddressLine1" : "Doe"},444 West Third Street", "modifiedDateaddressLine2" : 1331269200000null, "modifiedBy" : {"idcity" : "91f46e39-cea8-422b-b215-00f6bcf5d280Dayton", "firstNamestate" : "JohnOH", "lastNamezipCode" : "Doe45402"}, "objectStatusalternateAddressLineInUse" : "ACTIVE"null, "firstName" : "Sally", "middleInitialalternateAddressLine1" : null, "lastName" : "Student", "birthDatealternateAddressLine2" : null, "primaryEmailAddress" : "sally.student@university.edu", "secondaryEmailAddressalternateAddressCity" : null, "usernamealternateAddressState" : "sally.student"null, "homePhone" : "123-456-7890", "workPhonealternateAddressZipCode" : null, "cellPhonealternateAddressCountry" : null, "nonLocalAddressphotoUrl" : null, "addressLine1schoolId" : "444 West Third Street",null, "addressLine2enabled" : nullfalse, "citystudentIntakeCompleteDate" : "Dayton"null, "state" : "OH", "zipCodestudentType" : "45402", "alternateAddressLineInUse" : null, {"alternateAddressLine1id" : null"ce0d041d-d3ac-42a1-9085-7f744240e07e", "alternateAddressLine2" : null, "alternateAddressCity" : null, "alternateAddressStatename" : null,"Early Alert"alternateAddressZipCode" : null, "alternateAddressCountry" : null, "photoUrl" : null, "schoolIdobjectStatus" : null,"ACTIVE"},}, "studentIntakeCompleteDate" : null, "enabledcoach" : false, "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, "actualStartYearspecialServiceGroups" :2012, "studentType" : [{"id" : "ce0d041d437f6f2b-d3ac7b1e-42a147b4-90858603-7f744240e07e9e1208605c0d", "name" : "EarlyBasketball AlertTeam"}, "studentIntakeRequestDateobjectStatus" : 1331269200000 "ACTIVE"} ], "specialServiceGroupsreferralSources" : [{"id" : "437f6f2ba8c83fd4-7b1eee33-47b446ee-86038d89-9e1208605c0d9b2956696f37", "name" : "BasketballCounseling TeamServices", . "objectStatus" : "ACTIVE"}, ], "referralSourcesserviceReasons" : [{"id" : "a8c83fd4d95ea029-ee3390c1-46ee4be0-8d89b547-9b2956696f378054fc6914b7"}, "name" : "Developmental Education", "nameobjectStatus" : "Counseling Services"."ACTIVE"} ], "objectStatusconfidentialityLevels" : "ACTIVE"}null, ], "serviceReasonspermissions" : null, [{"idcurrentProgramStatusName" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}Active", "registeredForCurrentTerm" : true "nameactiveAlertsCount" :1, "Developmental Education", "closedAlertsCount":2, "objectStatuspaymentStatus":"Y :Y Y"ACTIVE"}, "registeredTerms":"2013FA 2013SP 2013SU" ], "confidentialityLevelsresidencyCounty" : null"Butler", "permissionsf1Status" : null,"Y", "currentProgramStatusNamegender" : "ActiveM", "registeredForCurrentTermmaritalStatus" :"Single", true "activeAlertsCountethnicity":1null, "closedAlertsCountactionPlanTaskOpenCount":24, "paymentStatusactionPlanTaskClosedCount":"Y15, Y Y", "registeredTermslastActionPlanCompletedDate":"2013FA1367297284590} 2013SP 2013SU" ] } |
Delete a Person
DELETE /ssp/api/1/person/{id}
...