Page Comparison

Get All Persons

GET /ssp/api/1/person

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

...

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:

registeredTerms removed in v2.4.0
paymentTerms removed in v2.4.0
career status added in v.2.7.0

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;

specialServiceGroups
referralSources
serviceReasons

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":"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
}

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",
   "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
}

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
}

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":"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" : "91f46e39859ff107-cea81326-422b11e2-b2158698-00f6bcf5d280406c8f22c3ce",
          "firstNamename" :"Student "JohnConduct",
          "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : 1331269200000,},
      { "modifiedBy" :
         {"id" : "91f46e39858b0cab-cea81326-422b11e2-b215818e-00f6bcf5d280406c8f22c3ce",
          "name"firstName:"HS :Guidance "JohnCounselor",

         "lastNameobjectStatus" : "DoeACTIVE"},
      },
"objectStatus" : "ACTIVE",    {  
"firstName" : "Sally",       "middleInitial" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "lastNamename" : "Student",Faculty /      "birthDate" : null,Staff Referral",
         "primaryEmailAddressobjectStatus" : "sally.student@university.edu",ACTIVE"
      },
"secondaryEmailAddress" : null,    {  
"username" : "sally.student",       "userId" : null,"id":"ccadd634-bd7a-11e1-8d28-3368721922dc",
         "homePhonename" : "123-456-7890Ombudsman",
         "objectStatus":"workPhoneACTIVE"
: null,     }
 "cellPhone" : null],
  
   "addressLine1serviceReasons":[ : "444
West Third Street",    {  
"addressLine2" : null,       "cityid" : "Dayton"0a640a2a-409d-1271-8140-d0b3878000f6",
         "statename" :"Scholarship "OHRecipient",
         "zipCodeobjectStatus" : "45402ACTIVE",
      },
"photoUrl" : null,    {  
"schoolId" : null,       "enabled" : false,"id":"85709794-1326-11e2-8bab-406c8f22c3ce",
         "coachIdname" :"Academically "10d6f4f2-cd80-4454-a475-4293dbaff436",Unprepared",
         "objectStatus"specialServiceGroupIds:"ACTIVE"
:       },
     [ {"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
          {"id" : "7bf36968f6201a04-ad48bb31-4c5f4ca5-9838b606-ebf495713c08609f3ad09f87"},
          ...
     "name":"At-Risk Student",
   ]},      {"idobjectStatus" : "63d62297-bf08-496f-acf3-0c129d437c2b","ACTIVE"
      "createdDate" : 1331269200000},
      "createdBy"{  :
         {"id" : "91f46e39205df6c0-cea8fea0-422b11e1-b2159678-00f6bcf5d280406c8f22c3ce",

         "firstNamename" :"Career Coaching"John",
          "lastNameobjectStatus" : "DoeACTIVE"},
      }
 "modifiedDate" : 1331269200000],
 
    "modifiedByconfidentialityLevels" :null,
     "permissions":null,
   {"idcurrentProgramStatusName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Active",
      "programStatusChangeReasonName":null,
   "firstNameregisteredForCurrentTerm" : "John",
      false,
   "lastNameactiveAlertsCount" : "Doe"}2,
   "closedAlertsCount":1,
   "objectStatusresidencyCounty" : "ACTIVEDemoCounty",
 
    "firstNamef1Status" : "BillY",
 
    "middleInitialgender" : null,
  "M",
   "lastNamemaritalStatus" : "SmithSeparated",
  
   "birthDateethnicity" : null,
 
    "primaryEmailAddressrace" : "bill.smith@university.edu",
 :null,
    "secondaryEmailAddressactionPlanTaskOpenCount" : null1,
 
    "usernameactionPlanTaskClosedCount" : "bill.smith",
  :4,
   "userIdlastActionPlanCompletedDate" : null1440076479537,
      "homePhoneconfidentialityDisclosureAgreementSignedDate" : "987-65-4321",
 :1440076476617,
    "workPhonehomeCampus":{ : null,
      "cellPhoneid" : null:"901e104b-4dc7-43f5-a38e-581015e204e1",
      "addressLine1name" : "110 North Front StreetCampus",
      "addressLine2objectStatus" :"ACTIVE"
null,   },
   "cityformattedCDACompleteDate" : "Dayton2015-08-20",
  
   "stateformattedStudentIntakeCompleteDate" : "OH",
null
}

Returns

Person

Code Block

{  
   "zipCodeid" : "45402"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
   "createdDate":1356998400000,
   "photoUrlcreatedBy":{ : null,
      "schoolIdid" : null:"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "enabledfirstName" : false"Demo",
      "coachIdlastName" : "10d6f4f2-cd80-4454-a475-4293dbaff436""Coach13",
      "specialServiceGroupIdsfullName" :"Demo Coach13"
     },
   [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}"modifiedDate":1444021202117,
   "modifiedBy":{  
      {"id" : "7bf3696858ba5ee3-ad48734e-4c5f4ae9-9838b9c5-ebf495713c08943774b4de41"},
      "firstName":"System",
   ...   "lastName":"Administrator",
      ]},"fullName":"System Administrator"
   },
 ...  "objectStatus":"ACTIVE",
  ] }

Get a Person

GET /ssp/api/1/person/{id}

Returns

Person

Code Block

{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "firstName":"James",
   "middleName":"Jacob",
   "lastName":"Anderson",
   "birthDate":"1986-10-24",
   "primaryEmailAddress":"demo@trainingssp.com",
   "firstNamesecondaryEmailAddress" : "John",
   "username":"janderson218",
   "lastNamehomePhone" : "Doe"}, 
 "modifiedDate" : 1331269200000,
 "modifiedBy" :"(555) 555-5412",
   "workPhone":"",
   "cellPhone":"",
    {"idalternatePhone" : "91f46e39212-cea8-422b-b215-00f6bcf5d280555-1212",
 
   "firstNamenonLocalAddress" : "John"false,
     "addressLine1"lastName:"321 : "Doe"}W. Demo St.",
   "objectStatusaddressLine2" :"Apt. "ACTIVE214",
   "firstNamecity" : "SallyPhoenix",
 "middleInitial"
: null,  "lastNamestate" : "StudentAZ",
   "birthDatezipCode" :"55555 null,  "primaryEmailAddress" : "sally.student@university.edu",
   "secondaryEmailAddressalternateAddressInUse":false,
: null,  "usernamealternateAddressLine1" : "sally.student",
   "alternateAddressLine2":"userId",
: null,  "homePhonealternateAddressCity" : "123-456-7890",
   "workPhonealternateAddressState":" : null",
   "alternateAddressZipCode"cellPhone:" :  null,  "addressLine1" : "444 West Third Street",
   "addressLine2alternateAddressCountry" : null"",
 "city" : "DaytonphotoUrl":null,
   "stateschoolId" : "OHjanderson218",
 "zipCode" : "45402enabled":true,
   "photoUrlstudentIntakeCompleteDate" : null,
   "schoolIdstudentType":{ : 
null,  "enabled" : false,  "coachIdid" : "10d6f4f20a640a2a-cd80409d-44541271-a4758140-4293dbaff436d0af4a4200ef",
 "specialServiceGroupIds" :     "name":"Non-Degree Seeking",
      [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},"objectStatus":"ACTIVE"
   },
   "coach":{  
      {"id" : "7bf3696822fc02f1-ad48d8b6-4c5f496c-98388e2d-ebf495713c0865f6973f888e"},
   
 ...     ]}

Create a Person

POST /ssp/api/1/person

Sample Post

Code Block

{"firstName" : "SallyDemo",
  "middleInitial" : null,  "lastName" : "StudentCoach13",
 "birthDate"  : null,  "primaryEmailAddress" : "sally.student@university.edu",
 "secondaryEmailAddress" : null,
 "username" : "sallydemo@trainingssp.studentcom",
 "userId"  : null,  "homePhoneworkPhone" : "123-456-7890"(777) 777-7777",
 "workPhone"  : null,  "cellPhoneofficeLocation" : null,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : departmentName":null,
 "city"  : "Dayton",  "statehomeCampusName" :"West "OHCampus",
  "zipCode" : "45402",  "photoUrl" : null,
 "schoolId" : null},
   "enabledabilityToBenefit":true,
: false,  "coachIdanticipatedStartTerm" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
   "specialServiceGroupIdsanticipatedStartYear" : 
2011,
   [{"idactualStartTerm" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}"FA2011",
   "actualStartYear":2011,
 {"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}studentIntakeRequestDate":1440076505197,
     ..."specialServiceGroups":[  
  ]}

Returns

Person

Code Block

{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :    {  
         {"id" : "91f46e39856a3600-cea81326-422b11e2-b2159b79-00f6bcf5d280406c8f22c3ce",
         "firstNamename" :"Student "JohnAthlete",
         "lastNameobjectStatus" : "Doe"ACTIVE"
      },
      {  "modifiedDate"
: 1331269200000,  "modifiedBy" :     {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0c138a100fd",
         "name"firstName:"DEI :Focus Group"John",
     "lastName" : "Doe"},   "objectStatus" : "ACTIVE",
    "firstName" : "Sally",}
 "middleInitial" : null],
 "lastName" : "StudentreferralSources",:[  "birthDate" :
null,  "primaryEmailAddress" : "sally.student@university.edu",  "secondaryEmailAddress"{ : null,
 "username" : "sally.student",  "userId" : null,  "homePhoneid" : "123-456-7890:"859ff107-1326-11e2-8698-406c8f22c3ce",
 "workPhone" : null,  "cellPhone" : null,  "addressLine1name" :"Student Conduct"444,
 West Third Street",  "addressLine2" : null,  "cityobjectStatus" : "DaytonACTIVE",
    "state" : "OH"},
  "zipCode" : "45402",  "photoUrl"{ : null,
 "schoolId" : null,  "enabled" : false,  "coachIdid" : "10d6f4f2858b0cab-cd801326-445411e2-a475818e-4293dbaff436406c8f22c3ce",
 "specialServiceGroupIds"  :      [{"name"id:"HS :Guidance "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},Counselor",
        { "idobjectStatus" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},"ACTIVE"
     ...  },
  ]}

Save a Person

PUT /ssp/api/1/person/{id}

Sample Post

Code Block

{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :   {  
         {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",
         "name"firstName:"Faculty / :Staff "JohnReferral",
         "lastNameobjectStatus" : "Doe"ACTIVE"
      },
      {  "modifiedDate"
: 1331269200000,  "modifiedBy" :     {"id" : "91f46e39ccadd634-cea8bd7a-422b11e1-b2158d28-00f6bcf5d2803368721922dc",
         "firstNamename" : "JohnOmbudsman",
     "lastName" : "Doe"},   "objectStatus" : "ACTIVE",
    "firstName" : "Sally",}
 "middleInitial" : null],
 "lastName" : "StudentserviceReasons",:[  "birthDate"
: null,  "primaryEmailAddress" : "sally.student@university.edu",  "secondaryEmailAddress"{ : null,
 "username" : "sally.student",  "userId" : null,  "homePhoneid" : "123-456-7890:"0a640a2a-409d-1271-8140-d0b3878000f6",
 "workPhone" : null,  "cellPhone" : null,  "addressLine1name" :"Scholarship Recipient"444,
 West Third Street",  "addressLine2" : null,  "cityobjectStatus" : "DaytonACTIVE",
    "state" : "OH"},
  "zipCode" : "45402",  "photoUrl"{ : null,
 "schoolId" : null,  "enabled" : false,  "coachIdid" : "10d6f4f285709794-cd801326-445411e2-a4758bab-4293dbaff436406c8f22c3ce",
  "specialServiceGroupIds" :      [{"idname" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},"Academically Unprepared",
        { "idobjectStatus" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},"ACTIVE"
      },
      {  
    ...     ]}

Returns

Person

Code Block

{"id" : "58ba5ee3f6201a04-734ebb31-4ae94ca5-b9c5b606-943774b4de41609f3ad09f87",
 "createdDate" :
1331269200000,  "createdBy"  :     {"idname" : "91f46e39-cea8-422b-b215-00f6bcf5d280",At-Risk Student",
         "firstNameobjectStatus" : "JohnACTIVE",

    "lastName" : "Doe"},
      {  "modifiedDate"
: 1331269200000,  "modifiedBy" :     {"id" : "91f46e39205df6c0-cea8fea0-422b11e1-b2159678-00f6bcf5d280406c8f22c3ce",
         "firstName" : "John","name":"Career Coaching",
         "objectStatus":"ACTIVE"
     "lastName" : "Doe"},
  "objectStatus" : "ACTIVE" ],
 "firstName" : "SallyconfidentialityLevels":null,
   "middleInitialpermissions" : null,
   "lastNamecurrentProgramStatusName" : "StudentActive",
   "birthDateprogramStatusChangeReasonName" : null,
 "primaryEmailAddress" : "sally.student@university.edu",registeredForCurrentTerm":false,
   "secondaryEmailAddressactiveAlertsCount" : null2,
 "username" : "sally.studentclosedAlertsCount":1,
   "residencyCounty":"userIdDemoCounty",
: null,  "homePhonef1Status" : "123-456-7890Y",
   "workPhonegender" : null,
 "cellPhoneM",
: null,  "addressLine1maritalStatus" : "444 West Third Street","Separated",
   "addressLine2ethnicity" : null,
 "city" : "Daytonrace":null,
 "state" : "OHactionPlanTaskOpenCount":1,
 "zipCode" : "45402actionPlanTaskClosedCount":4,
   "photoUrllastActionPlanCompletedDate" : null,
 "schoolId" : null,1440076479537,
   "enabledconfidentialityDisclosureAgreementSignedDate" : false1440076476617,
 "coachId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
 "specialServiceGroupIds" :homeCampus":{  
      [{"id" : "437f6f2b901e104b-7b1e4dc7-47b443f5-8603a38e-9e1208605c0d581015e204e1"},
      {"idname" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}"North Campus",
     ...
 "objectStatus":"ACTIVE"
   ]}},
   "formattedCDACompleteDate":"2015-08-20",
   "formattedStudentIntakeCompleteDate":n

Delete a Person

DELETE /ssp/api/1/person/{id}

Security

PERSON_DELETE

Returns

Code Block
{"success" : "true"}

...

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

Versions Compared

Old Version 13

New Version Current

Key

Get All Persons

Overview

Get All Persons

Get All Persons Who Are Coaches

Get a Person

Get a Person by School ID

Create a Person

Save a Person

Get a Person

Create a Person

Save a Person

Delete a Person