Get All Challenges for Person
GET /ssp/api/1/person/{id}/challenge
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
Returns
List<Challenge>
...
Overview
Methods for accessing a person. A person can be a student, advisor, or any other type of individual in the system.
The programStatus that is returned is the currently assigned program status. Use the Person Program Status API to select all program statuses for the person.
Info |
---|
Changelog:
|
Info |
---|
The function of "combined" ObjectStatus values produce a top-level ObjectStatus value for an entity which might itself be associated with other statused entities. E.g. a Person is associated with zero or more SpecialServiceGroups. Each individual association is actually represented by a third entity: PersonSpecialServiceGroups. This enables the application to support soft-deletes of these associations, which is potentially useful for reporting. But it creates a problem for the UI, which should suppress display of any PersonSpecialServiceGroup where either it or the associated SpecialServiceGroup has been set into a deleted ObjectStatus. The follow reference items persist throughout the application and are handled by the ObjectStatus functionality;
|
Get All Persons
GET /ssp/api/1/person
Security
PERSON_READ
Parameters
status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
Returns
Code Block |
---|
{
"id":"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
"createdDate":1356998400000,
"createdBy":{
"id":"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
"firstName":"Demo",
"lastName":"Coach13",
"fullName":"Demo Coach13"
},
"modifiedDate":1444021202117,
"modifiedBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"objectStatus":"ACTIVE",
"firstName":"James",
"middleName":"Jacob",
"lastName":"Anderson",
"birthDate":"1986-10-24",
"primaryEmailAddress":"demo@trainingssp.com",
"secondaryEmailAddress":"",
"username":"janderson218",
"homePhone":"(555) 555-5412",
"workPhone":"",
"cellPhone":"",
"alternatePhone":"212-555-1212",
"nonLocalAddress":false,
"addressLine1":"321 W. Demo St.",
"addressLine2":"Apt. 214",
"city":"Phoenix",
"state":"AZ",
"zipCode":"55555 ",
"alternateAddressInUse":false,
"alternateAddressLine1":"",
"alternateAddressLine2":"",
"alternateAddressCity":"",
"alternateAddressState":" ",
"alternateAddressZipCode":" ",
"alternateAddressCountry":"",
"photoUrl":null,
"schoolId":"janderson218",
"enabled":true,
"studentIntakeCompleteDate":null,
"studentType":{
"id":"0a640a2a-409d-1271-8140-d0af4a4200ef",
"name":"Non-Degree Seeking",
"objectStatus":"ACTIVE"
},
"coach":{
"id":"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
"firstName":"Demo",
"lastName":"Coach13",
"primaryEmailAddress":"demo@trainingssp.com",
"workPhone":"(777) 777-7777",
"officeLocation":null,
"departmentName":null,
"homeCampusName":"West Campus",
"photoUrl":null
},
"abilityToBenefit":true,
"anticipatedStartTerm":"",
"anticipatedStartYear":2011,
"actualStartTerm":"FA2011",
"actualStartYear":2011,
"studentIntakeRequestDate":1440076505197,
"specialServiceGroups":[
{
"id":"856a3600-1326-11e2-9b79-406c8f22c3ce",
"name":"Student Athlete",
"objectStatus":"ACTIVE"
},
{
"id":"0a640a2a-409d-1271-8140-d0c138a100fd",
"name":"DEI Focus Group",
"objectStatus":"ACTIVE"
}
],
"referralSources":[
{
"id":"859ff107-1326-11e2-8698-406c8f22c3ce",
"name":"Student Conduct",
"objectStatus":"ACTIVE"
},
{
"id":"858b0cab-1326-11e2-818e-406c8f22c3ce",
"name":"HS Guidance Counselor",
"objectStatus":"ACTIVE"
},
{
"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
"name":"Faculty / Staff Referral",
"objectStatus":"ACTIVE"
},
{
"id":"ccadd634-bd7a-11e1-8d28-3368721922dc",
"name":"Ombudsman",
"objectStatus":"ACTIVE"
}
],
"serviceReasons":[
{
"id":"0a640a2a-409d-1271-8140-d0b3878000f6",
"name":"Scholarship Recipient",
"objectStatus":"ACTIVE"
},
{
"id":"85709794-1326-11e2-8bab-406c8f22c3ce",
"name":"Academically Unprepared",
"objectStatus":"ACTIVE"
},
{
"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
"name":"At-Risk Student",
"objectStatus":"ACTIVE"
},
{
"id":"205df6c0-fea0-11e1-9678-406c8f22c3ce",
"name":"Career Coaching",
"objectStatus":"ACTIVE"
}
],
"confidentialityLevels":null,
"permissions":null,
"currentProgramStatusName":"Active",
"programStatusChangeReasonName":null,
"registeredForCurrentTerm":false,
"activeAlertsCount":2,
"closedAlertsCount":1,
"residencyCounty":"DemoCounty",
"f1Status":"Y",
"gender":"M",
"maritalStatus":"Separated",
"ethnicity":null,
"race":null,
"actionPlanTaskOpenCount":1,
"actionPlanTaskClosedCount":4,
"lastActionPlanCompletedDate":1440076479537,
"confidentialityDisclosureAgreementSignedDate":1440076476617,
"homeCampus":{
"id":"901e104b-4dc7-43f5-a38e-581015e204e1",
"name":"North Campus",
"objectStatus":"ACTIVE"
},
"formattedCDACompleteDate":"2015-08-20",
"formattedStudentIntakeCompleteDate":null
} |
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":"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
"createdDate":1356998400000,
"createdBy":{
"id":"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
"firstName":"Demo",
"lastName":"Coach13",
"fullName":"Demo Coach13"
},
"modifiedDate":1444021202117,
"modifiedBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"objectStatus":"ACTIVE",
"firstName":"James",
"middleName":"Jacob",
"lastName":"Anderson",
"birthDate":"1986-10-24",
"primaryEmailAddress":"demo@trainingssp.com",
"secondaryEmailAddress":"",
"username":"janderson218",
"homePhone":"(555) 555-5412",
"workPhone":"",
"cellPhone":"",
"alternatePhone":"212-555-1212",
"nonLocalAddress":false,
"addressLine1":"321 W. Demo St.",
"addressLine2":"Apt. 214",
"city":"Phoenix",
"state":"AZ",
"zipCode":"55555 ",
"alternateAddressInUse":false,
"alternateAddressLine1":"",
"alternateAddressLine2":"",
"alternateAddressCity":"",
"alternateAddressState":" ",
"alternateAddressZipCode":" ",
"alternateAddressCountry":"",
"photoUrl":null,
"schoolId":"janderson218",
"enabled":true,
"studentIntakeCompleteDate":null,
"studentType":{
"id":"0a640a2a-409d-1271-8140-d0af4a4200ef",
"name":"Non-Degree Seeking",
"objectStatus":"ACTIVE"
},
"coach":{
"id":"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
"firstName":"Demo",
"lastName":"Coach13",
"primaryEmailAddress":"demo@trainingssp.com",
"workPhone":"(777) 777-7777",
"officeLocation":null,
"departmentName":null,
"homeCampusName":"West Campus",
"photoUrl":null
},
"abilityToBenefit":true,
"anticipatedStartTerm":"",
"anticipatedStartYear":2011,
"actualStartTerm":"FA2011",
"actualStartYear":2011,
"studentIntakeRequestDate":1440076505197,
"specialServiceGroups":[
{
"id":"856a3600-1326-11e2-9b79-406c8f22c3ce",
"name":"Student Athlete",
"objectStatus":"ACTIVE"
},
{
"id":"0a640a2a-409d-1271-8140-d0c138a100fd",
"name":"DEI Focus Group",
"objectStatus":"ACTIVE"
}
],
"referralSources":[
{
"id":"859ff107-1326-11e2-8698-406c8f22c3ce",
"name":"Student Conduct",
"objectStatus":"ACTIVE"
},
{
"id":"858b0cab-1326-11e2-818e-406c8f22c3ce",
"name":"HS Guidance Counselor",
"objectStatus":"ACTIVE"
},
{
"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
"name":"Faculty / Staff Referral",
"objectStatus":"ACTIVE"
},
{
"id":"ccadd634-bd7a-11e1-8d28-3368721922dc",
"name":"Ombudsman",
"objectStatus":"ACTIVE"
}
],
"serviceReasons":[
{
"id":"0a640a2a-409d-1271-8140-d0b3878000f6",
"name":"Scholarship Recipient",
"objectStatus":"ACTIVE"
},
{
"id":"85709794-1326-11e2-8bab-406c8f22c3ce",
"name":"Academically Unprepared",
"objectStatus":"ACTIVE"
},
{
"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
"name":"At-Risk Student",
"objectStatus":"ACTIVE"
},
{
"id":"205df6c0-fea0-11e1-9678-406c8f22c3ce",
"name":"Career Coaching",
"objectStatus":"ACTIVE"
}
],
"confidentialityLevels":null,
"permissions":null,
"currentProgramStatusName":"Active",
"programStatusChangeReasonName":null,
"registeredForCurrentTerm":false,
"activeAlertsCount":2,
"closedAlertsCount":1,
"residencyCounty":"DemoCounty",
"f1Status":"Y",
"gender":"M",
"maritalStatus":"Separated",
"ethnicity":null,
"race":null,
"actionPlanTaskOpenCount":1,
"actionPlanTaskClosedCount":4,
"lastActionPlanCompletedDate":1440076479537,
"confidentialityDisclosureAgreementSignedDate":1440076476617,
"homeCampus":{
"id":"901e104b-4dc7-43f5-a38e-581015e204e1",
"name":"North Campus",
"objectStatus":"ACTIVE"
},
"formattedCDACompleteDate":"2015-08-20",
"formattedStudentIntakeCompleteDate":null
} |
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":"d77f4697-ed36-4477-b8d0-67c9a1d8b2db", "createdDate":1356998400000, "createdBy":{ "id":"22fc02f1-d8b6-496c-8e2d-65f6973f888e", "firstName":"Demo", "lastName":"Coach13", "fullName":"Demo Coach13" }, "modifiedDate":1444021202117, "modifiedBy":{ "id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41", "firstName":"System", "lastName":"Administrator", "fullName":"System Administrator" }, "objectStatus":"ACTIVE", "firstName":"James", "middleName":"Jacob", "lastName":"Anderson", "birthDate":"1986-10-24", "primaryEmailAddress":"demo@trainingssp.com", "secondaryEmailAddress":"", "username":"janderson218", "homePhone":"(555) 555-5412", "workPhone":"", "cellPhone":"", "alternatePhone":"212-555-1212", "nonLocalAddress":false, "addressLine1":"321 W. Demo St.", "addressLine2":"Apt. 214", "city":"Phoenix", "state":"AZ", "zipCode":"55555 ", "alternateAddressInUse":false, "alternateAddressLine1":"", "alternateAddressLine2":"", "alternateAddressCity":"", "alternateAddressState":" ", "alternateAddressZipCode":" ", "alternateAddressCountry":"", "photoUrl":null, "schoolId":"janderson218", "enabled":true, "studentIntakeCompleteDate":null, "studentType":{ "id":"0a640a2a-409d-1271-8140-d0af4a4200ef", "name":"Non-Degree Seeking", "objectStatus":"ACTIVE" }, "coach":{ "id":"22fc02f1-d8b6-496c-8e2d-65f6973f888e", "firstName":"Demo", "lastName":"Coach13", "primaryEmailAddress":"demo@trainingssp.com", "workPhone":"(777) 777-7777", "officeLocation":null, "departmentName":null, "homeCampusName":"West Campus", "photoUrl":null }, "abilityToBenefit":true, "anticipatedStartTerm":"", "anticipatedStartYear":2011, "actualStartTerm":"FA2011", "actualStartYear":2011, "studentIntakeRequestDate":1440076505197, "specialServiceGroups":[ { "id":"856a3600-1326-11e2-9b79-406c8f22c3ce", "name":"Student Athlete", "objectStatus":"ACTIVE" }, { "id":"0a640a2a-409d-1271-8140-d0c138a100fd", "name":"DEI Focus Group", "objectStatus":"ACTIVE" } ], "referralSources":[ { "id":"859ff107-1326-11e2-8698-406c8f22c3ce", "name":"Student Conduct", "objectStatus":"ACTIVE" }, { "id":"858b0cab-1326-11e2-818e-406c8f22c3ce", "name":"HS Guidance Counselor", "objectStatus":"ACTIVE" }, { "id":"f6201a04-bb31-4ca5-b606-609f3ad09f87", "name":"Faculty / Staff Referral", "objectStatus":"ACTIVE" }, { "id":"ccadd634-bd7a-11e1-8d28-3368721922dc", "name":"Ombudsman", "objectStatus":"ACTIVE" } ], "serviceReasons":[ { "id":"0a640a2a-409d-1271-8140-d0b3878000f6", "name":"Scholarship Recipient", "objectStatus":"ACTIVE" }, { "id":"85709794-1326-11e2-8bab-406c8f22c3ce", "name":"Academically Unprepared", "objectStatus":"ACTIVE" }, { "id":"f6201a04-bb31-4ca5-b606-609f3ad09f87", "name":"At-Risk Student", "objectStatus":"ACTIVE" }, { {"id" : "91f46e39205df6c0-cea8fea0-422b11e1-b2159678-00f6bcf5d280406c8f22c3ce", "firstNamename" :"Career Coaching"John", "lastNameobjectStatus" : "DoeACTIVE"}, "modifiedDate"} : "2008-04-09T12:07:56", ], "modifiedByconfidentialityLevels" :null, "permissions":null, {"idcurrentProgramStatusName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Active", "programStatusChangeReasonName":null, "registeredForCurrentTerm":false, "firstNameactiveAlertsCount" : "John", 2, "closedAlertsCount":1, "lastNameresidencyCounty" : "DoeDemoCounty"}, "f1Status":"Y", "objectStatusgender" : "ACTIVEM", "namemaritalStatus" : "Child CareSeparated", "ethnicity":null, "descriptionrace" :null, "Child care description text."actionPlanTaskOpenCount":1, "actionPlanTaskClosedCount":4, "tagslastActionPlanCompletedDate":1440076479537, : "child,kids,daycare,babysitter"confidentialityDisclosureAgreementSignedDate":1440076476617, "showInStudentIntakehomeCampus":{ : "true", "showInSelfHelpSearchid" : "false"901e104b-4dc7-43f5-a38e-581015e204e1", "selfHelpGuideQuestionname" :"North "Campus", "selfHelpGuideDescriptionobjectStatus" : "ACTIVE"}, {"id" : "3c952070-7fe5-11e1-b0c4-0800200c9a66", }, "createdDateformattedCDACompleteDate" : "20082015-04-09T12:07:5608-20", "createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280formattedStudentIntakeCompleteDate":null } |
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":"James", "firstName" : "John", "middleName":"Jacob", "lastName" : "DoeAnderson"}, "modifiedDatebirthDate" : "20081986-04-09T12:07:5610-24", "modifiedByprimaryEmailAddress" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280"demo@trainingssp.com", "secondaryEmailAddress":"", "firstNameusername" : "Johnjanderson218", "homePhone":"(555) 555-5412", "lastNameworkPhone" : "Doe"}, "objectStatuscellPhone" : "ACTIVE", "namealternatePhone" : "Enhancing Academic Excellence"212-555-1212", "nonLocalAddress":false, "descriptionaddressLine1" : "Opportunities321 forW. students seeking to take their academics to the next level.", Demo St.", "addressLine2":"Apt. 214", "tagscity" : "honors,grades,deanPhoenix", "showInStudentIntakestate" : "trueAZ", "showInSelfHelpSearchzipCode" : "false",55555 ", "selfHelpGuideQuestion" : "alternateAddressInUse":false, "selfHelpGuideDescriptionalternateAddressLine1" : ""}, ... ] |
Get All Journal Entries for Person
GET /ssp/api/1/person/{id}/journalEntry
Notes
entryDate may be different than the createDate if an entry is back-dated.
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : "ASC" or "DESC" or "ASCENDING" or "DESCENDING"
Returns
List<JournalEntry>
Code Block |
---|
[{"id" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "createdBy" :"alternateAddressLine2":"", "alternateAddressCity":"", "alternateAddressState":" ", "alternateAddressZipCode":" ", "alternateAddressCountry":"", "photoUrl":null, "schoolId":"janderson218", "enabled":true, "studentIntakeCompleteDate":null, "studentType":{ {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0af4a4200ef", "firstNamename" :"Non-Degree Seeking"John", "lastNameobjectStatus" : "DoeACTIVE"}, "modifiedDate" :}, 1332216000000, "modifiedBycoach":{ : {"id" : "91f46e3922fc02f1-cea8d8b6-422b496c-b215-00f6bcf5d280", "firstName" : "John8e2d-65f6973f888e", "lastNamefirstName" : "DoeDemo"}, "objectStatuslastName" : "ACTIVECoach13", "entryDate" : 1332216000000, "commentprimaryEmailAddress" : "demo@trainingssp.com", "confidentialityLevel" : "EVERYONE", "journalSourceIdworkPhone" : "aabf0232-5994-4108-986e-cfb6f28724ae", "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e","(777) 777-7777", "journalStepDetailsofficeLocation" :null, [{"iddepartmentName" : "23befc50-7f91-11e1-b0c4-0800200c9a66":null, "createdDatehomeCampusName" :"West "1332216000000Campus", "createdByphotoUrl" :null }, "abilityToBenefit":true, {"idanticipatedStartTerm" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "anticipatedStartYear":2011, "firstNameactualStartTerm" : "JohnFA2011", "actualStartYear":2011, "studentIntakeRequestDate":1440076505197, "lastNamespecialServiceGroups":[ : "Doe"}, { "modifiedDate" : "1332216000000", "modifiedByid" : :"856a3600-1326-11e2-9b79-406c8f22c3ce", {"idname" :"Student "91f46e39-cea8-422b-b215-00f6bcf5d280", Athlete", "firstNameobjectStatus" : "John",ACTIVE" }, { "lastName" : "Doe"}, "objectStatusid" : "ACTIVE"0a640a2a-409d-1271-8140-d0c138a100fd", "name" : "ActionDEI PlanFocus DevelopedGroup", "description" : "Action plan developed with student.", "objectStatus":"ACTIVE" } ], "sortOrderreferralSources":[ : 1}, {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", "createdDate" : "1332216000000",id":"859ff107-1326-11e2-8698-406c8f22c3ce", "createdByname" :"Student Conduct", {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280","ACTIVE" }, "firstName" : "John",{ "lastNameid" : "Doe"},"858b0cab-1326-11e2-818e-406c8f22c3ce", "modifiedDatename":"HS :Guidance "1332216000000Counselor", "modifiedByobjectStatus" :"ACTIVE" }, {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", { "firstNameid" : "John:"f6201a04-bb31-4ca5-b606-609f3ad09f87", "name"lastName:"Faculty : "Doe"}/ Staff Referral", "objectStatus" : "ACTIVE", }, "name" : "Discussed Financial Aid Information", { "descriptionid" : "Discussed financial aid information with student and determined any additional financial needs.":"ccadd634-bd7a-11e1-8d28-3368721922dc", "name":"Ombudsman", "sortOrderobjectStatus" :"ACTIVE" 2}, {"id" : "3ac714c7-390d-4994-ac43-5de0a0ac9832",} ], "createdDateserviceReasons" :[ "1332216000000", "createdBy" :{ {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0b3878000f6", "firstNamename" :"Scholarship "JohnRecipient", "lastNameobjectStatus" : "DoeACTIVE"}, "modifiedDate" : "1332216000000"}, "modifiedBy"{ : {"id" : "91f46e3985709794-cea81326-422b11e2-b2158bab-00f6bcf5d280406c8f22c3ce", "firstNamename" :"Academically "JohnUnprepared", "lastName" : "Doe"}, "objectStatus" : "ACTIVE" }, "name"{ : "Follow-Up Appointment Made", "descriptionid" : "Follow-up appointment made with student.""f6201a04-bb31-4ca5-b606-609f3ad09f87", "sortOrdername" : 3},"At-Risk Student", ... "objectStatus":"ACTIVE" ] }, {"id" : "3c952070-7fe5-11e1-b0c4-0800200c9a66", "createdDate"{ : "2008-04-09T12:07:56", "createdBy" : {"id" : "91f46e39205df6c0-cea8fea0-422b11e1-b2159678-00f6bcf5d280406c8f22c3ce", "firstNamename" :"Career Coaching"John", "lastNameobjectStatus" : "DoeACTIVE"}, "modifiedDate" : "2008-04-09T12:07:56", "modifiedBy"} : ], {"idconfidentialityLevels":null, : "91f46e39-cea8-422b-b215-00f6bcf5d280"permissions":null, "firstNamecurrentProgramStatusName" : "JohnActive", "programStatusChangeReasonName":null, "lastNameregisteredForCurrentTerm" : "Doe"}false, "objectStatus" : "ACTIVEactiveAlertsCount":2, "entryDateclosedAlertsCount" :1, 1332216000000, "commentresidencyCounty" : "DemoCounty", "confidentialityLevelf1Status" : "EVERYONEY", "journalSourceIdgender" : "aabf0232-5994-4108-986e-cfb6f28724ae"M", "journalTrackIdmaritalStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e"Separated", "journalStepDetailsethnicity":null, : "race":null, [{"idactionPlanTaskOpenCount" : "23befc50-7f91-11e1-b0c4-0800200c9a66":1, "actionPlanTaskClosedCount":4, "createdDatelastActionPlanCompletedDate" : "1332216000000"1440076479537, "confidentialityDisclosureAgreementSignedDate":1440076476617, "createdByhomeCampus" : { {"id" : "91f46e39901e104b-cea84dc7-422b43f5-b215a38e-00f6bcf5d280581015e204e1", "firstNamename" :"North Campus"John", "lastNameobjectStatus" : "DoeACTIVE"}, }, "modifiedDateformattedCDACompleteDate" : "13322160000002015-08-20", "modifiedByformattedStudentIntakeCompleteDate" : null } |
Returns
Person
Code Block |
---|
{ {"id" : "91f46e39d77f4697-cea8ed36-422b4477-b215b8d0-00f6bcf5d28067c9a1d8b2db", "createdDate":1356998400000, "firstNamecreatedBy" : "John", :{ "lastNameid" : "Doe"}"22fc02f1-d8b6-496c-8e2d-65f6973f888e", "objectStatusfirstName" : "ACTIVEDemo", "namelastName" : "Action Plan DevelopedCoach13", "descriptionfullName" :"Demo Coach13"Action plan developed with student."}, "modifiedDate":1444021202117, "sortOrdermodifiedBy":{ : 1}, {"id" : "7ed6d72058ba5ee3-7f91734e-11e14ae9-b0c4b9c5-0800200c9a66943774b4de41", "createdDatefirstName" : "1332216000000System", "createdBylastName" : "Administrator", {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280","fullName":"System Administrator" }, "objectStatus":"ACTIVE", "firstName" : "JohnJames", "middleName":"Jacob", "lastName":"Anderson", "lastNamebirthDate" : "Doe1986-10-24"}, "primaryEmailAddress":"demo@trainingssp.com", "modifiedDatesecondaryEmailAddress" : "1332216000000", "username":"janderson218", "homePhone"modifiedBy:" :(555) 555-5412", "workPhone":"", "cellPhone":"", {"idalternatePhone" : "91f46e39-cea8212-422b555-b215-00f6bcf5d2801212", "nonLocalAddress":false, "firstNameaddressLine1" : "John",321 W. Demo St.", "addressLine2":"Apt. 214", "lastNamecity" : "DoePhoenix"}, "state":"AZ", "objectStatuszipCode" :"55555 "ACTIVE", ", "namealternateAddressInUse" :false, "Discussed Financial Aid Information"alternateAddressLine1":"", "alternateAddressLine2":"", "descriptionalternateAddressCity" : ""Discussed, financial aid information with student and determined any additional financial needs. "alternateAddressState":" ", "alternateAddressZipCode":" "sortOrder" : 2}", {"idalternateAddressCountry" : "3ac714c7-390d-4994-ac43-5de0a0ac9832", "photoUrl":null, "createdDateschoolId" : "1332216000000janderson218", "enabled":true, "createdBystudentIntakeCompleteDate":null, : "studentType":{ {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0af4a4200ef", "firstNamename" : "John", "lastName" : "Doe"}"Non-Degree Seeking", "modifiedDateobjectStatus" : "1332216000000ACTIVE", }, "modifiedBycoach" :{ {"id" : "91f46e3922fc02f1-cea8d8b6-422b496c-b2158e2d-00f6bcf5d28065f6973f888e", "firstName" : "JohnDemo", "lastName" : "DoeCoach13"}, "objectStatusprimaryEmailAddress" : "ACTIVEdemo@trainingssp.com", "nameworkPhone" : "Follow-Up Appointment Made", "(777) 777-7777", "descriptionofficeLocation":null, : "Follow-up appointment made with student.""departmentName":null, "sortOrderhomeCampusName" :"West 3}Campus", ..."photoUrl":null }, ] }] |
Get One Journal Entry for a Person
POST /ssp/api/1/person/{id}/journalEntry/{id}
Returns
JournalEntry
Code Block |
---|
{"id" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66"abilityToBenefit":true, "anticipatedStartTerm":"", "createdDateanticipatedStartYear":2011, : 1332216000000, "createdByactualStartTerm" :"FA2011", "actualStartYear":2011, {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", studentIntakeRequestDate":1440076505197, "firstNamespecialServiceGroups" :[ "John", "lastName" : "Doe"}, { "modifiedDate" : 1332216000000, "modifiedBy" : {"id" : "91f46e39856a3600-cea81326-422b11e2-b2159b79-00f6bcf5d280406c8f22c3ce", "firstNamename" :"Student "JohnAthlete", "lastName" : "Doe"}, "objectStatus" : "ACTIVE", "entryDate" : 1332216000000}, "comment" : "",{ "confidentialityLevel" : "EVERYONE", "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae", "journalTrackIdid" : "1ec338870a640a2a-7d5e409d-47701271-aef28140-049a8314130ed0c138a100fd", "journalStepDetails" : [{"name"id:"DEI : "23befc50-7f91-11e1-b0c4-0800200c9a66Focus Group", "createdDateobjectStatus" : "1332216000000ACTIVE", } "createdBy" : ], "referralSources":[ {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", { "firstNameid" : "John"859ff107-1326-11e2-8698-406c8f22c3ce", "lastNamename" :"Student "Doe"},Conduct", "modifiedDateobjectStatus" : "1332216000000",ACTIVE" }, "modifiedBy" :{ {"id" : "91f46e39858b0cab-cea81326-422b11e2-b215818e-00f6bcf5d280406c8f22c3ce", "name"firstName:"HS :Guidance "JohnCounselor", "lastNameobjectStatus" : "Doe"},ACTIVE" }, { "objectStatusid" : "ACTIVE"f6201a04-bb31-4ca5-b606-609f3ad09f87", "name" :"Faculty "Action/ PlanStaff DevelopedReferral", "objectStatus":"ACTIVE" "description" : "Action plan developed}, with student.", { "sortOrder" : 1}, {"id" : "7ed6d720ccadd634-7f91bd7a-11e1-b0c48d28-0800200c9a663368721922dc", "createdDatename" : "1332216000000Ombudsman", "createdBy" : "objectStatus":"ACTIVE" } ], {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",serviceReasons":[ { "firstNameid" : "John"0a640a2a-409d-1271-8140-d0b3878000f6", "lastNamename" :"Scholarship "Doe"},Recipient", "modifiedDateobjectStatus" : "1332216000000",ACTIVE" }, "modifiedBy" :{ {"id" : "91f46e3985709794-cea81326-422b11e2-b2158bab-00f6bcf5d280406c8f22c3ce", "firstNamename" :"Academically Unprepared"John", "lastNameobjectStatus" : "Doe"},ACTIVE" }, { "objectStatusid" : "ACTIVE"f6201a04-bb31-4ca5-b606-609f3ad09f87", "name" :"At-Risk Student"Discussed, Financial Aid Information", "descriptionobjectStatus" : "Discussed financial aid information with student and determined any additional financial needs.""ACTIVE" }, { "sortOrder" : 2}, {"id" : "3ac714c7205df6c0-390dfea0-499411e1-ac439678-5de0a0ac9832406c8f22c3ce", "createdDatename" :"Career "1332216000000Coaching", "createdBy "objectStatus":"ACTIVE" : } ], {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280"confidentialityLevels":null, "permissions":null, "currentProgramStatusName":"Active", "firstNameprogramStatusChangeReasonName":null, : "JohnregisteredForCurrentTerm":false, "activeAlertsCount":2, "closedAlertsCount":1, "lastNameresidencyCounty" : "DoeDemoCounty"}, "modifiedDatef1Status" : "1332216000000Y", "modifiedBygender" : :"M", {"idmaritalStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Separated", "ethnicity":null, "race":null, "firstNameactionPlanTaskOpenCount":1, : "JohnactionPlanTaskClosedCount":4, "lastActionPlanCompletedDate":1440076479537, "confidentialityDisclosureAgreementSignedDate":1440076476617, "lastNamehomeCampus" :{ "Doe"}, "objectStatusid" : "ACTIVE:"901e104b-4dc7-43f5-a38e-581015e204e1", "name" : "Follow-Up Appointment MadeNorth Campus", "descriptionobjectStatus" : "Follow-up appointment made with student."ACTIVE" }, "sortOrderformattedCDACompleteDate" : 3}:"2015-08-20", ... ]"formattedStudentIntakeCompleteDate":null } |
...
Save a Person
PUT PUT /ssp/api/1/person/{id}/journalEntry
Sample Post
JournalEntryTO
...
/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":"d77f4697-ed36-4477-b8d0-67c9a1d8b2db", "createdDate":1356998400000, "createdBy":{ : {"id" : "91f46e3922fc02f1-cea8d8b6-422b496c-b2158e2d-00f6bcf5d28065f6973f888e", "firstName" : "JohnDemo", "lastName":"Coach13", "fullName":"Demo "Doe"Coach13" }, "modifiedDate":1444021202117, : 1332216000000, "modifiedBy":{ : {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41", "firstName" : "JohnSystem", "lastName" : "DoeAdministrator"}, "objectStatus" : "ACTIVE", "entryDatefullName" : 1332216000000, "comment" : "", "confidentialityLevel" : "EVERYONE", "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae", "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e", "journalStepDetails" : [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66"}, {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"}, {"id" : "3ac714c7-390d-4994-ac43-5de0a0ac9832"}, ... ] } |
Returns
JournalEntryTO
Code Block |
---|
{"id" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : 1332216000000, "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "objectStatus" : "ACTIVE", "entryDate" : 1332216000000, "comment" : "", "confidentialityLevel" : "EVERYONE", "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae", "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e", "journalStepDetails" : [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66", "createdDate" : "1332216000000", "createdBy" : "System Administrator" }, "objectStatus":"ACTIVE", "firstName":"James", "middleName":"Jacob", "lastName":"Anderson", "birthDate":"1986-10-24", "primaryEmailAddress":"demo@trainingssp.com", "secondaryEmailAddress":"", "username":"janderson218", "homePhone":"(555) 555-5412", "workPhone":"", "cellPhone":"", "alternatePhone":"212-555-1212", "nonLocalAddress":false, "addressLine1":"321 W. Demo St.", "addressLine2":"Apt. 214", "city":"Phoenix", "state":"AZ", "zipCode":"55555 ", "alternateAddressInUse":false, "alternateAddressLine1":"", "alternateAddressLine2":"", "alternateAddressCity":"", "alternateAddressState":" ", "alternateAddressZipCode":" ", "alternateAddressCountry":"", "photoUrl":null, "schoolId":"janderson218", "enabled":true, "studentIntakeCompleteDate":null, "studentType":{ {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0af4a4200ef", "name":"Non-Degree Seeking", "firstNameobjectStatus" : "JohnACTIVE" }, "coach":{ "lastNameid" : "Doe"}, "22fc02f1-d8b6-496c-8e2d-65f6973f888e", "modifiedDatefirstName" : "1332216000000Demo", "modifiedBylastName" :"Coach13", {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "primaryEmailAddress":"demo@trainingssp.com", "firstNameworkPhone" :"(777) 777-7777"John", "officeLocation":null, "lastName" : "DoedepartmentName"}:null, "objectStatushomeCampusName" :"West "ACTIVECampus", "namephotoUrl":null : "Action Plan Developed"}, "abilityToBenefit":true, "descriptionanticipatedStartTerm" : "Action plan developed with student.", "sortOrderanticipatedStartYear" : 1}2011, {"idactualStartTerm" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"FA2011", "actualStartYear":2011, "createdDate" :studentIntakeRequestDate":1440076505197, "1332216000000specialServiceGroups",:[ "createdBy" :{ {"id" : "91f46e39856a3600-cea81326-422b11e2-b2159b79-00f6bcf5d280406c8f22c3ce", "firstNamename" :"Student "JohnAthlete", "lastNameobjectStatus" : "Doe"},ACTIVE" }, { "modifiedDateid" : "1332216000000"0a640a2a-409d-1271-8140-d0c138a100fd", "modifiedByname" :"DEI Focus Group", {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280","ACTIVE" } ], "firstNamereferralSources" : "John",[ { "lastName" : "Doe"}, "objectStatusid" : "ACTIVE"859ff107-1326-11e2-8698-406c8f22c3ce", "name" :"Student Conduct"Discussed, Financial Aid Information", "descriptionobjectStatus" : "ACTIVE"Discussed financial aid information with student and determined any additional financial needs."}, { "sortOrder" : 2}, {"id" : "3ac714c7858b0cab-390d1326-499411e2-ac43-5de0a0ac9832", "createdDate" : "1332216000000",818e-406c8f22c3ce", "createdByname" :"HS Guidance Counselor", {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280","ACTIVE" }, "firstName" : "John",{ "lastNameid" : "Doe"},"f6201a04-bb31-4ca5-b606-609f3ad09f87", "name"modifiedDate:"Faculty / :Staff Referral"1332216000000", "modifiedByobjectStatus" :"ACTIVE" }, {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", { "firstNameid" : "John"ccadd634-bd7a-11e1-8d28-3368721922dc", "lastNamename" : "DoeOmbudsman"}, "objectStatus" : "ACTIVE", } "name" : "Follow-Up Appointment Made"], "descriptionserviceReasons":[ : "Follow-up appointment made with student." { "sortOrder" : 3}, "id":"0a640a2a-409d-1271-8140-d0b3878000f6", ... ] } |
Save Journal Entry for a Person
PUT /ssp/api/1/person/{id}/journalEntry
Sample Post
JournalEntryTO
Code Block |
---|
{"id" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "createdBy" : "name":"Scholarship Recipient", "objectStatus":"ACTIVE" }, { {"id" : "91f46e3985709794-cea81326-422b11e2-b2158bab-00f6bcf5d280406c8f22c3ce", "firstNamename" :"Academically "JohnUnprepared", "lastNameobjectStatus" : "Doe"ACTIVE" }, "modifiedDate" : 1332216000000, "modifiedBy" : { {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87", "firstNamename" :"At-Risk Student"John", "lastName" : "Doe"}, "objectStatus" : "ACTIVE" }, { "entryDate" : 1332216000000, "commentid" : ""205df6c0-fea0-11e1-9678-406c8f22c3ce", "confidentialityLevel" : "EVERYONE", "journalSourceIdname" : "aabf0232-5994-4108-986e-cfb6f28724ae","Career Coaching", "journalTrackIdobjectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e", "journalStepDetails" : "ACTIVE" } ], [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66"confidentialityLevels":null, "permissions":null, "createdDatecurrentProgramStatusName" : "1332216000000Active", "programStatusChangeReasonName":null, "createdByregisteredForCurrentTerm" :false, "activeAlertsCount":2, "closedAlertsCount":1, {"idresidencyCounty" : "91f46e39-cea8-422b-b215-00f6bcf5d280"DemoCounty", "f1Status":"Y", "gender":"M", "firstNamemaritalStatus" : "JohnSeparated", "ethnicity":null, "race":null, "lastNameactionPlanTaskOpenCount" : "Doe"}1, "actionPlanTaskClosedCount":4, "modifiedDatelastActionPlanCompletedDate" : "1332216000000"1440076479537, "confidentialityDisclosureAgreementSignedDate":1440076476617, "modifiedByhomeCampus" : { {"id" : "91f46e39901e104b-cea84dc7-422b43f5-b215a38e-00f6bcf5d280581015e204e1", "name":"North Campus", "firstNameobjectStatus" : "JohnACTIVE", }, "formattedCDACompleteDate":"2015-08-20", "lastNameformattedStudentIntakeCompleteDate" :null "Doe"}, } |
Returns
Person
Code Block |
---|
{ "objectStatusid" : "ACTIVE"d77f4697-ed36-4477-b8d0-67c9a1d8b2db", "createdDate":1356998400000, "namecreatedBy" :{ "Action Plan Developed", "descriptionid" : "Action plan developed with student.", "22fc02f1-d8b6-496c-8e2d-65f6973f888e", "sortOrderfirstName" : 1}:"Demo", {"idlastName" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"Coach13", "createdDatefullName" :"Demo "1332216000000Coach13", }, "createdBymodifiedDate":1444021202117, : "modifiedBy":{ {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41", "firstName" : "JohnSystem", "lastName" : "DoeAdministrator"}, "modifiedDatefullName" :"System "1332216000000Administrator", }, "modifiedByobjectStatus" : :"ACTIVE", {"idfirstName" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "James", "firstNamemiddleName" : "John", Jacob", "lastName" : "DoeAnderson"}, "birthDate":"1986-10-24", "objectStatusprimaryEmailAddress" : "ACTIVEdemo@trainingssp.com", "namesecondaryEmailAddress" : "Discussed Financial Aid Information", "descriptionusername" : "Discussed financial aid information with student and determined any additional financial needs." "janderson218", "sortOrderhomePhone" : 2}"(555) 555-5412", {"idworkPhone" : "3ac714c7-390d-4994-ac43-5de0a0ac9832:"", "cellPhone":"", "createdDatealternatePhone" : "1332216000000212-555-1212", "nonLocalAddress":false, "createdByaddressLine1" :"321 W. Demo St.", "addressLine2":"Apt. 214", {"idcity" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Phoenix", "state":"AZ", "firstNamezipCode" : "John",55555 ", "alternateAddressInUse":false, "lastNamealternateAddressLine1" : "Doe"}, "modifiedDatealternateAddressLine2" : "1332216000000", , "modifiedByalternateAddressCity" :"", "alternateAddressState":" ", {"id"alternateAddressZipCode":" : "91f46e39-cea8-422b-b215-00f6bcf5d280", ", "firstNamealternateAddressCountry" : "John", "photoUrl":null, "schoolId":"janderson218", "lastNameenabled" : "Doe"}true, "studentIntakeCompleteDate":null, "objectStatusstudentType" :{ "ACTIVE", "nameid" : "Follow-Up Appointment Made"0a640a2a-409d-1271-8140-d0af4a4200ef", "descriptionname" : "Follow-up appointment made with student.":"Non-Degree Seeking", "sortOrder"objectStatus":"ACTIVE" : 3}, "coach":{ ... ] } |
Returns
JournalEntryTO
Code Block |
---|
{"id" : "240e97c022fc02f1-7fe5d8b6-11e1496c-b0c48e2d-0800200c9a6665f6973f888e", "createdDate" : 1332216000000, "firstName":"createdByDemo", : {"idlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Coach13", "firstNameprimaryEmailAddress" : "Johndemo@trainingssp.com", "lastNameworkPhone" :"(777) 777-7777"Doe"}, "modifiedDate" : 1332216000000, "modifiedByofficeLocation":null, : {"iddepartmentName" : "91f46e39-cea8-422b-b215-00f6bcf5d280",null, "firstNamehomeCampusName" :"West Campus"John", "lastNamephotoUrl":null : "Doe"}, "objectStatus" : "ACTIVEabilityToBenefit":true, "entryDateanticipatedStartTerm" : 1332216000000"", "comment" : "anticipatedStartYear":2011, "confidentialityLevelactualStartTerm" : "EVERYONEFA2011", "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae"actualStartYear":2011, "journalTrackIdstudentIntakeRequestDate" : "1ec33887-7d5e-4770-aef2-049a8314130e",:1440076505197, "journalStepDetailsspecialServiceGroups":[ : [{{ "id" : "23befc50856a3600-7f911326-11e111e2-b0c49b79-0800200c9a66406c8f22c3ce", "createdDatename" :"Student Athlete"1332216000000", "createdByobjectStatus":"ACTIVE" : }, { "id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0c138a100fd", "name"firstName:"DEI :Focus "JohnGroup", "lastNameobjectStatus" : "Doe"},ACTIVE" } ], "modifiedDatereferralSources" : "1332216000000",[ "modifiedBy" :{ {"id" : "91f46e39859ff107-cea81326-422b11e2-b2158698-00f6bcf5d280406c8f22c3ce", "firstNamename" :"Student "JohnConduct", "lastNameobjectStatus" : "Doe"},ACTIVE" }, { "objectStatusid" : "ACTIVE"858b0cab-1326-11e2-818e-406c8f22c3ce", "name" : "ActionHS PlanGuidance DevelopedCounselor", "objectStatus":"descriptionACTIVE" : "Action plan developed}, with student.", { "sortOrder" : 1}, {"id" : "7ed6d720f6201a04-7f91bb31-11e14ca5-b0c4b606-0800200c9a66609f3ad09f87", "createdDate" : "1332216000000",name":"Faculty / Staff Referral", "createdByobjectStatus":"ACTIVE" : }, { "id" : "91f46e39ccadd634-cea8bd7a-422b11e1-b2158d28-00f6bcf5d2803368721922dc", "firstNamename" : "JohnOmbudsman", "lastNameobjectStatus" : "Doe"},ACTIVE" } ], "modifiedDateserviceReasons" :[ "1332216000000", "modifiedBy" :{ {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0b3878000f6", "firstNamename" :"Scholarship Recipient"John", "lastNameobjectStatus" : "Doe"ACTIVE" }, { "objectStatus" : "ACTIVE", "id":"85709794-1326-11e2-8bab-406c8f22c3ce", "name" :"Academically Unprepared"Discussed, Financial Aid Information", "descriptionobjectStatus" : "ACTIVE"Discussed financial aid information with student and determined}, any additional financial needs." { "sortOrder" : 2}, {"id" : "3ac714c7f6201a04-390dbb31-49944ca5-ac43b606-5de0a0ac9832609f3ad09f87", "createdDatename" :"At-Risk Student"1332216000000", "objectStatus":"createdByACTIVE" : }, { "id" : "91f46e39205df6c0-cea8fea0-422b11e1-b2159678-00f6bcf5d280406c8f22c3ce", "name":"Career Coaching", "firstNameobjectStatus" : "JohnACTIVE", } ], "lastName" : "DoeconfidentialityLevels"}:null, "permissions":null, "modifiedDatecurrentProgramStatusName" : "1332216000000Active", "programStatusChangeReasonName":null, "modifiedByregisteredForCurrentTerm" :false, "activeAlertsCount":2, "closedAlertsCount":1, {"idresidencyCounty" : "91f46e39-cea8-422b-b215-00f6bcf5d280"DemoCounty", "f1Status":"Y", "gender":"M", "firstNamemaritalStatus" : "JohnSeparated", "ethnicity":null, "race":null, "lastNameactionPlanTaskOpenCount":1, : "DoeactionPlanTaskClosedCount"}:4, "lastActionPlanCompletedDate":1440076479537, "objectStatusconfidentialityDisclosureAgreementSignedDate":1440076476617, : "ACTIVEhomeCampus",:{ "nameid" : "Follow-Up Appointment Made"901e104b-4dc7-43f5-a38e-581015e204e1", "descriptionname" : "Follow-up appointment made with student." North Campus", "sortOrderobjectStatus" :"ACTIVE" 3}, }, ..."formattedCDACompleteDate":"2015-08-20", ] } |
...
"formattedStudentIntakeCompleteDate":n |
Delete a Person
DELETE DELETE /ssp/api/1/person/{id}/journalEntry/{id}
Security
PERSON_DELETE
Returns
Code Block |
---|
{"success" : "true"} |
...
Code Block |
---|
{"success" : "false", "message" : "Message when success is false."} |
Get History for Person
GET /ssp/api/1/person/{id}/history/print
Security
PERSON_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
Returns
PDF Report - To be completed by Unicon