Versions Compared

Old Version 45

changes.mady.by.user Jason Elwood

Saved on

compared with

New Version Current

changes.mady.by.user Jason Elwood

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

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

{"success" : "true", "results" : "100", "rows" : [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41", "createdDate" : 1331269200000, "createdBy" :
Code Block
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" : "91f46e3922fc02f1-cea8d8b6-422b496c-b2158e2d-00f6bcf5d28065f6973f888e",
   
      "firstName" : "JohnDemo",
      "lastName":"Coach13",
      "lastNamefullName" :"Demo "DoeCoach13"},
   },
   "modifiedDate" : 13312692000001444021202117,
      "modifiedBy" :{  
       {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
   
      "firstName" : "JohnSystem",
      "lastName":"Administrator",
      "lastNamefullName" :"System "DoeAdministrator"},
   },
   "objectStatus" : "ACTIVE",
  
   "firstName" : "SallyJames",
      "middleInitialmiddleName" : null"Jacob",

     "lastName" : "StudentAnderson",

     "birthDate" : null,
  :"1986-10-24",
   "primaryEmailAddress" : "sallydemo@trainingssp.student@university.educom",
  
   "secondaryEmailAddress" : null"",
      "username" : "sally.studentjanderson218",
 
    "homePhone" : "123-456-7890"(555) 555-5412",
      "workPhone" : null"",
      "cellPhone" :"",
null,   "alternatePhone":"212-555-1212",
   "nonLocalAddress" : nullfalse,
      "addressLine1" : "444321 WestW. ThirdDemo StreetSt.",
  
   "addressLine2" :"Apt. null214",

     "city" : "DaytonPhoenix",
 
    "state" : "OHAZ",
      "zipCode" : "45402",55555     ",
   "alternateAddressLineInUsealternateAddressInUse" : nullfalse,
  
   "alternateAddressLine1" : null"",
      "alternateAddressLine2" : null"",
      "alternateAddressCity" : null"",
      "alternateAddressState":" : null",
      "alternateAddressZipCode" :" null,       "alternateAddressCountry" : null",
   "alternateAddressCountry":"",
   "photoUrl" : null,
  
   "schoolId" : null,
  "janderson218",
   "enabled" : falsetrue,
      "studentIntakeCompleteDate" : null,
      "studentType" :
{  
      {"id" : "ce0d041d0a640a2a-d3ac409d-42a11271-90858140-7f744240e07ed0af4a4200ef",
      "name":"Non-Degree Seeking",
      "nameobjectStatus" : "ACTIVE"Early
Alert"},   },
   "coach" :{  
       {"id" : "91f46e3922fc02f1-cea8d8b6-422b496c-b2158e2d-00f6bcf5d28065f6973f888e",
          "firstName" : "AmyDemo",
  
       "lastName" : "AdvisorCoach13",
          "primaryEmailAddress" : "amy.advisor@universitydemo@trainingssp.educom",

         "workPhone" : "(123777) 456777-78907777",
          "officeLocation":null,
:  "123 Benton Hall Room A"departmentName":null,
   
      "departmentNamehomeCampusName" : "Engineering & Applied Science"}, West Campus",
      "strengthsphotoUrl":null
: "Good test taker"},
 
    "abilityToBenefit" : true,
      "anticipatedStartTerm" : "Fall",
   "anticipatedStartYear":2011,
   "anticipatedStartYearactualStartTerm" : "2012FA2011",
   "actualStartYear":2011,
   "studentIntakeRequestDate":1440076505197,
   "specialServiceGroups":[  
1331269200000,      { "specialServiceGroupIds" : 
         [{"id" : "437f6f2b856a3600-7b1e1326-47b411e2-86039b79-9e1208605c0d406c8f22c3ce"},
          {"idname" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}"Student Athlete",
          ..."objectStatus":"ACTIVE"
          ]},
      "referralSourceIds"{ : 
         [{"id" : "a8c83fd40a640a2a-ee33409d-46ee1271-8d898140-9b2956696f37d0c138a100fd"},
          {"name"id:"DEI : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"}Focus Group",
          ..."objectStatus":"ACTIVE"
      }
   ],
      "serviceReasonIdsreferralSources" :[  
        [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}, 
         {"id" : "c9ff0ce6859ff107-aec61326-4be211e2-b1d18698-9ca385edc637406c8f22c3ce"},
          ..."name":"Student Conduct",
         ],"objectStatus":"ACTIVE"
      "confidentialityLevels"},
: null,     {  
 "permissions" : null,       "currentProgramStatusNameid" : "Active"858b0cab-1326-11e2-818e-406c8f22c3ce",

     "registeredForCurrentTerm" : true}     ]
}

 

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" : "name":"HS Guidance Counselor",
         "objectStatus":"ACTIVE"
      },
      {  
         [{"id" : "58ba5ee3f6201a04-734ebb31-4ae94ca5-b9c5b606-943774b4de41609f3ad09f87",
         "name"firstName:"Faculty :/ Staff Referral"Camden",
         "lastNameobjectStatus" : "Coach"ACTIVE"
      },
      {  
         "id" : "63d62297ccadd634-bf08bd7a-496f11e1-acf38d28-0c129d437c2b3368721922dc",
         "firstNamename" : "ChristinaOmbudsman",
         "lastNameobjectStatus" : "CoachACTIVE"},
      }
 ...  ],
  ] }

 

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" :"serviceReasons":[  
      {  
         {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0b3878000f6",
         "firstNamename" :"Scholarship "JohnRecipient",
         "lastNameobjectStatus" : "Doe"ACTIVE"
      },
    "modifiedDate" : 1331269200000,
 "modifiedBy" :  {  
         {"id" : "91f46e3985709794-cea81326-422b11e2-b2158bab-00f6bcf5d280406c8f22c3ce",
     "firstName" : "John"    "name":"Academically Unprepared",
         "objectStatus":"ACTIVE"
      },
     "lastName" :{ "Doe"}, 
 "objectStatus" : "ACTIVE",  "firstName" : "Sally",  "middleInitialid" : null:"f6201a04-bb31-4ca5-b606-609f3ad09f87",
 "lastName" : "Student",  "birthDate" : null,  "primaryEmailAddressname" :"At-Risk Student"sally.student@university.edu",
 "secondaryEmailAddress" : null,  "username" : "sally.student",  "homePhoneobjectStatus" : "123-456-7890ACTIVE",
 "workPhone" : null,  "cellPhone" : null},
 "nonLocalAddress"   : null, { "addressLine1" :
"444 West Third Street",  "addressLine2" : null,  "cityid" : "Dayton"205df6c0-fea0-11e1-9678-406c8f22c3ce",
 "state" : "OH",  "zipCode" : "45402",  "alternateAddressLineInUsename" :"Career nullCoaching",
 "alternateAddressLine1" : null,  "alternateAddressLine2" : null,  "alternateAddressCityobjectStatus" :"ACTIVE"
null,  "alternateAddressState" : null,  "alternateAddressZipCode"}
: null,  "alternateAddressCountry"],
: null,  "photoUrlconfidentialityLevels" : null,
   "schoolIdpermissions" : null,
 "enabled" : false,  "currentProgramStatusName":"Active",
   "studentIntakeCompleteDateprogramStatusChangeReasonName" : null,
   "coachregisteredForCurrentTerm" :
false,
   {"idactiveAlertsCount" : "91f46e39-cea8-422b-b215-00f6bcf5d280":2,
     "firstNameclosedAlertsCount" : "Amy"1,

    "lastNameresidencyCounty" : "AdvisorDemoCounty",
     "primaryEmailAddressf1Status" : "amy.advisor@university.eduY",

    "workPhonegender" : "(123) 456-7890"M",
     "officeLocationmaritalStatus" : "Separated"123,
Benton Hall Room A"ethnicity":null,
 
   "departmentNamerace" :null,
"Engineering & Applied Science"actionPlanTaskOpenCount"}:1,
   "strengthsactionPlanTaskClosedCount" : "Good4,
test taker",  "abilityToBenefitlastActionPlanCompletedDate" : true1440076479537,
 "anticipatedStartTerm" : "FallconfidentialityDisclosureAgreementSignedDate":1440076476617,
   "anticipatedStartYearhomeCampus" :{ "2012", 
"studentType" :     {"id" : "ce0d041d901e104b-d3ac4dc7-42a143f5-9085a38e-7f744240e07e581015e204e1",
      "name" : "EarlyNorth AlertCampus"},
 "studentIntakeRequestDate"  : 1331269200000,  "specialServiceGroupIds" : 
    [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"objectStatus":"ACTIVE"
   },
     {"idformattedCDACompleteDate" : "7bf369682015-ad48-4c5f-9838-ebf495713c08"}08-20",
     ...
    ],
 "referralSourceIds" : 
    [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
     {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
     ...
    ],
 "serviceReasonIds" : 
    [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}"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",
     { "idfirstName" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"}"Demo",
     ... "lastName":"Coach13",
    ],  "confidentialityLevelsfullName" :"Demo null,Coach13"
   "permissions"},
: null,  "currentProgramStatusNamemodifiedDate":1444021202117,
: "Active",  "registeredForCurrentTerm" : true
}

 

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" : modifiedBy":{  
      "id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :     "firstName":"System",
      "lastName":"Administrator",
      {"idfullName" :"System "91f46e39-cea8-422b-b215-00f6bcf5d280"Administrator"
   },
   "objectStatus":"ACTIVE",
   "firstName" : "JohnJames",
   "middleName":"Jacob",
   "lastName" : "DoeAnderson"},
  "modifiedDate" : 1331269200000, "birthDate":"1986-10-24",
   "modifiedByprimaryEmailAddress" :
:"demo@trainingssp.com",
   {"idsecondaryEmailAddress" : "91f46e39-cea8-422b-b215-00f6bcf5d280",

    "firstNameusername" : "Johnjanderson218",
 
   "lastNamehomePhone" :"(555) 555-5412"Doe"},
   "objectStatusworkPhone" : "ACTIVE",
   "firstNamecellPhone" : "Sally",

"middleInitial" : null,  "lastNamealternatePhone" : "Student212-555-1212",
   "birthDatenonLocalAddress":false,
: null,  "primaryEmailAddressaddressLine1" :"321 "sally.student@university.edu",
 "secondaryEmailAddress" : null,W. Demo St.",
   "usernameaddressLine2" : "sallyApt.student 214",
   "homePhonecity" : "123-456-7890Phoenix",
   "workPhonestate" : null,
 "cellPhoneAZ",
: null,  "nonLocalAddresszipCode" :"55555 null,  "addressLine1" : "444,
West Third Street",  "addressLine2alternateAddressInUse":false,
: null,  "cityalternateAddressLine1" : "Dayton",
   "statealternateAddressLine2" : "OH",
   "zipCodealternateAddressCity" : "45402",
   "alternateAddressLineInUsealternateAddressState" : null,"  "alternateAddressLine1",
: null,  "alternateAddressLine2alternateAddressZipCode" : null,"  "alternateAddressCity" : null,  "alternateAddressState" : null,  "alternateAddressZipCode",
: null,  "alternateAddressCountry":"",
: null,  "photoUrl" : null,
   "schoolId":"janderson218",
   "enabled":true,
 null,  "studentIntakeCompleteDate" : null,
   "enabledstudentType" :{ false, 
"coach" :     {"id" : "91f46e390a640a2a-409d-cea81271-422b-b215-00f6bcf5d2808140-d0af4a4200ef",
      "name":"Non-Degree Seeking",
      "objectStatus":"firstName" :ACTIVE"
   },
   "Amy",coach":{  
      "lastNameid" : "Advisor"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "primaryEmailAddressfirstName" : "amy.advisor@university.eduDemo",
      "workPhonelastName" : "(123) 456-7890"Coach13",
      "officeLocationprimaryEmailAddress" : "123 Benton Hall Room A"demo@trainingssp.com",
      "departmentNameworkPhone" : "Engineering & Applied Science"}(777) 777-7777",
 "strengths" : "Good test taker",  "abilityToBenefitofficeLocation" : truenull,
 "anticipatedStartTerm" : "Fall",  "anticipatedStartYear" : "2012departmentName":null,
 "studentType" :     {"idhomeCampusName" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"West Campus",
      "namephotoUrl":null
 : "Early Alert"},
   "studentIntakeRequestDateabilityToBenefit":true,
: 1331269200000,  "specialServiceGroupIdsanticipatedStartTerm":"",
:   "anticipatedStartYear":2011,
   [{"idactualStartTerm" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}"FA2011",
   "actualStartYear":2011,
   {"idstudentIntakeRequestDate":1440076505197,
:   "7bf36968-ad48-4c5f-9838-ebf495713c08"},specialServiceGroups":[  
    ...  {  
],  "referralSourceIds" :      [{"id" : "a8c83fd4856a3600-ee331326-46ee11e2-8d899b79-9b2956696f37406c8f22c3ce"},
         {"idname" :"Student "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
 Athlete",
   ...     ],  "serviceReasonIdsobjectStatus" :"ACTIVE"
     [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
     {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
 {  
  ...     ],  "confidentialityLevels" : null,"id":"0a640a2a-409d-1271-8140-d0c138a100fd",
     "permissions" : null,  "currentProgramStatusNamename":"DEI :Focus Group"Active",
 "registeredForCurrentTerm" : true
}

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" : "Sally",
 "middleInitial" : 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,
 "coach" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280        "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",
         "firstNamename" : "Amy",Faculty / Staff Referral",
  "lastName" : "Advisor",      "primaryEmailAddressobjectStatus" : "amy.advisor@university.edu",
ACTIVE"
    "workPhone" : "(123) 456-7890", },
      "officeLocation"{ : "123
Benton Hall Room A",      "departmentName" : "Engineering & Applied Science"},
 "strengths" : "Good test takerid":"ccadd634-bd7a-11e1-8d28-3368721922dc",
         "name":"Ombudsman",
 "abilityToBenefit" : true,  "anticipatedStartTerm" : "Fall",  "anticipatedStartYearobjectStatus" : "2012ACTIVE",
  "studentType" :   }
 {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
  ],
   "nameserviceReasons" : "Early Alert"},:[  "studentIntakeRequestDate"
: 1331269200000,  "specialServiceGroupIds" :  {  
 [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},      {"id" : "7bf369680a640a2a-ad48409d-4c5f1271-98388140-ebf495713c08d0b3878000f6"},
     ...     ]"name":"Scholarship Recipient",
 "referralSourceIds"  :      [{"idobjectStatus" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},"ACTIVE"
     {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
     ... {  
 ],
 "serviceReasonIds" :      [{"id" : "d95ea02985709794-90c11326-4be011e2-b5478bab-8054fc6914b7406c8f22c3ce"},
      {   "idname" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"}"Academically Unprepared",
     ...     ],
 "confidentialityLevelsobjectStatus" :"ACTIVE"
null,    "permissions" : null},
 "currentProgramStatusName" : "Active",  "registeredForCurrentTerm" : null
}

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",  "createdDate"
: 1331269200000,  "createdBy" :     {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",
         "firstNamename" : "John"At-Risk Student",
     "lastName" : "Doe"},   "modifiedDateobjectStatus" :"ACTIVE"
1331269200000,  "modifiedBy" :   },
  {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",  {  
 "firstName" : "John",      "lastNameid" : "Doe"}"205df6c0-fea0-11e1-9678-406c8f22c3ce",
  "objectStatus" : "ACTIVE",       "firstNamename" :"Career "SallyCoaching",
  "middleInitial" : null,       "lastNameobjectStatus" : "StudentACTIVE",
    "birthDate" : null,}
 "primaryEmailAddress" : "sally.student@university.edu" ],
   "secondaryEmailAddressconfidentialityLevels" : null,
 "username" : "sally.studentpermissions":null,
   "homePhonecurrentProgramStatusName" : "123-456-7890Active",
   "workPhoneprogramStatusChangeReasonName" : null,
   "cellPhoneregisteredForCurrentTerm":false,
: null,  "addressLine1activeAlertsCount" :2,
"444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton "closedAlertsCount":1,
   "residencyCounty":"DemoCounty",
   "f1Status":"Y",
   "stategender" : "OHM",
   "zipCodemaritalStatus" : "45402Separated",
   "nonLocalAddressethnicity" : null,
   "alternateAddressLineInUserace" : null,
   "alternateAddressLine1actionPlanTaskOpenCount":1,
: null,  "alternateAddressLine2actionPlanTaskClosedCount":4,
: null,  "alternateAddressCitylastActionPlanCompletedDate":1440076479537,
: null,  "alternateAddressStateconfidentialityDisclosureAgreementSignedDate":1440076476617,
: null,  "alternateAddressZipCodehomeCampus" : null,
 "alternateAddressCountry" : null,
 "photoUrl" : null,
 "schoolId" : null,
 "enabled" : false,
 "studentIntakeCompleteDate" : null,
 "coach" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "Amy",:{  
      "id":"901e104b-4dc7-43f5-a38e-581015e204e1",
      "name":"North Campus",
      "objectStatus":"ACTIVE"
   },
   "formattedCDACompleteDate":"2015-08-20",
   "formattedStudentIntakeCompleteDate":null
}

Returns

Person

Code Block
{  
   "lastNameid" : "Advisor"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
   "createdDate":1356998400000,
   "primaryEmailAddresscreatedBy" : "amy.advisor@university.edu",{  
      "workPhoneid" : "(123) 456-7890"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "officeLocationfirstName" : "123 Benton Hall Room A"Demo",
      "departmentNamelastName":"Coach13",
: "Engineering & Applied Science"},  "strengthsfullName" : "GoodDemo test takerCoach13",
 "abilityToBenefit" : true},
 "anticipatedStartTerm" : "FallmodifiedDate":1444021202117,
   "anticipatedStartYearmodifiedBy" :{ "2012", 
"studentType" :     {"id" : "ce0d041d58ba5ee3-d3ac734e-42a14ae9-9085b9c5-7f744240e07e943774b4de41",
      "namefirstName" : "Early AlertSystem"},
  "studentIntakeRequestDate" : 1331269200000,  "lastName"specialServiceGroupIds:"Administrator",
:      [{"idfullName" :"System "437f6f2b-7b1e-47b4-8603-9e1208605c0d"Administrator"
   },
     {"idobjectStatus" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}"ACTIVE",
   "firstName":"James",
 ...  "middleName":"Jacob",
  ],  "referralSourceIdslastName" : 
:"Anderson",
   [{"idbirthDate" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
 :"1986-10-24",
   {"idprimaryEmailAddress" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"}"demo@trainingssp.com",
   "secondaryEmailAddress":"",
 ...  "username":"janderson218",
  ],  "serviceReasonIdshomePhone" : 
"(555) 555-5412",
   [{"idworkPhone" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
 
   {"idcellPhone" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
     ...
    ],"alternatePhone":"212-555-1212",
   "confidentialityLevelsnonLocalAddress" : nullfalse,
   "permissionsaddressLine1" :"321 null,W. Demo St."currentProgramStatusName",
: "Active",  "registeredForCurrentTerm" : true
}

 

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" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280addressLine2":"Apt. 214",
   "city":"Phoenix",
   "state":"AZ",
   "zipCode":"55555     ",
   "alternateAddressInUse":false,
   "alternateAddressLine1":"",
   "alternateAddressLine2":"",
   "firstNamealternateAddressCity":"",
:   "JohnalternateAddressState":",  ",
   "alternateAddressZipCode"lastName" : "Doe"}:"          ",
   "alternateAddressCountry":"modifiedDate",
: 1331269200000,  "modifiedByphotoUrl" :null,
    {"idschoolId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"janderson218",
   "enabled":true,
 "firstName" : "JohnstudentIntakeCompleteDate":null,
 
   "lastNamestudentType":{ : "Doe"},
  "objectStatus" : "ACTIVE",  "firstNameid" : "Sally"0a640a2a-409d-1271-8140-d0af4a4200ef",
  "middleInitial" : null,  "lastNamename" :"Non-Degree Seeking"Student",
 "birthDate"  : null,  "primaryEmailAddressobjectStatus" : "sally.student@university.edu",ACTIVE"
   },
   "secondaryEmailAddresscoach":{ : 
null,  "username" : "sally.student",  "homePhoneid" : "123-456-789022fc02f1-d8b6-496c-8e2d-65f6973f888e",
 "workPhone"  : null,  "cellPhonefirstName" :"Demo",
null,  "nonLocalAddress" : null,  "addressLine1lastName" : "444 West Third Street"Coach13",
  "addressLine2" : null,  "cityprimaryEmailAddress" : "Daytondemo@trainingssp.com",
 "state"  : "OH",  "zipCodeworkPhone" :"(777) 777-7777"45402",
 "alternateAddressLineInUse"  : null,  "alternateAddressLine1officeLocation" : null,
  "alternateAddressLine2" : null,  "alternateAddressCitydepartmentName" : null,
  "alternateAddressState" : null,  "alternateAddressZipCodehomeCampusName" :"West nullCampus",
 "alternateAddressCountry"  : null,  "photoUrl" : null,
 "schoolId" : null},
   "enabledabilityToBenefit":true,
: false,  "studentIntakeCompleteDateanticipatedStartTerm" : null,
 "coach",
:     {"idanticipatedStartYear" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 :2011,
   "firstNameactualStartTerm" : "AmyFA2011",
   "actualStartYear":2011,
   "lastNamestudentIntakeRequestDate":1440076505197,
:   "Advisor",specialServiceGroups":[  
      {  
 "primaryEmailAddress" : "amy.advisor@university.edu",      "workPhoneid" : "(123) 456-7890"856a3600-1326-11e2-9b79-406c8f22c3ce",
         "officeLocationname" :"Student Athlete"123,
Benton Hall Room A",      "departmentNameobjectStatus" : "Engineering & Applied Science"},
 "strengths" : "Good test taker",
 "abilityToBenefit" : true,
 "anticipatedStartTerm" : "Fall",
 "anticipatedStartYear" : "2012",
 "studentType" :"ACTIVE"
      },
      {  
         {"id" : "ce0d041d0a640a2a-d3ac409d-42a11271-90858140-7f744240e07ed0c138a100fd",
         "name" :"DEI "EarlyFocus AlertGroup"},
   "studentIntakeRequestDate"   : 1331269200000,  "specialServiceGroupIdsobjectStatus" :"ACTIVE"
     [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
   ],
 {"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},  "referralSources":[  
    ...  {  
],  "referralSourceIds" :      [{"id" : "a8c83fd4859ff107-ee331326-46ee11e2-8d898698-9b2956696f37406c8f22c3ce"},
        { "idname" :"Student "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},Conduct",
          ..."objectStatus":"ACTIVE"
      ]},
 "serviceReasonIds"   :  {  
 [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},      {"id" : "c9ff0ce6858b0cab-aec61326-4be211e2-b1d1818e-9ca385edc637406c8f22c3ce"},
     ...     ]"name":"HS Guidance Counselor",
 "confidentialityLevels"   : null,    "objectStatus"permissions:"ACTIVE"
 : null,  "currentProgramStatusName" : "Active"},
 "registrationStatusForCurrentTerm" : true }

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" : {  
         {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215-00f6bcf5d280",b606-609f3ad09f87",
         "name"firstName:"Faculty / :Staff Referral"John",
         "lastNameobjectStatus" : "Doe"}, 
 "modifiedDate" : 1331269200000,
 "modifiedBy" :ACTIVE"
      },
      {  
         {"id" : "91f46e39ccadd634-cea8bd7a-422b11e1-b2158d28-00f6bcf5d2803368721922dc",
         "firstNamename" : "JohnOmbudsman",
         "lastNameobjectStatus" : "Doe"},ACTIVE"
      }
   ],
   "objectStatusserviceReasons":[ : 
"ACTIVE",  "firstName" : "Sally",  "middleInitial"{ : null,
 "lastName" : "Student",  "birthDate" : null,  "primaryEmailAddressid" : "sally.student@university.edu"0a640a2a-409d-1271-8140-d0b3878000f6",
 "secondaryEmailAddress" : null,  "username" : "sally.student",  "homePhonename" :"Scholarship Recipient"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,
 "studentIntakeCompleteDate" : null,
 "enabled" : false,
 "coach" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280objectStatus":"ACTIVE"
      },
      {  
         "id":"85709794-1326-11e2-8bab-406c8f22c3ce",
         "name":"Academically Unprepared",
         "objectStatus":"ACTIVE"
      },
      {  
         "id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "firstNamename" : "Amy"At-Risk Student",
         "lastNameobjectStatus" : "Advisor"ACTIVE"
      },
     "primaryEmailAddress" : "amy.advisor@university.edu", {  
         "workPhoneid" : "(123) 456-7890","205df6c0-fea0-11e1-9678-406c8f22c3ce",
         "officeLocationname" :"Career Coaching"123,
Benton Hall Room A",       "objectStatus"departmentName:"ACTIVE"
  : "Engineering & Applied Science"},
 "strengths" : "Good],
test taker",  "abilityToBenefitconfidentialityLevels" : truenull,
 "anticipatedStartTerm" : "Fallpermissions":null,
   "anticipatedStartYearcurrentProgramStatusName" : "2012Active",
   "studentTypeprogramStatusChangeReasonName" :null,
    {"idregisteredForCurrentTerm" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
 :false,
   "nameactiveAlertsCount" :2,
"Early Alert"},  "studentIntakeRequestDateclosedAlertsCount":1,
: 1331269200000,  "specialServiceGroupIdsresidencyCounty" : 
:"DemoCounty",
   [{"idf1Status" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}"Y",
     {"idgender" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}"M",
   "maritalStatus":"Separated",
 ...  "ethnicity":null,
  ],  "referralSourceIdsrace" : 
null,
   [{"idactionPlanTaskOpenCount" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"}:1,
     {"idactionPlanTaskClosedCount" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"}:4,
   "lastActionPlanCompletedDate":1440076479537,
 ...  "confidentialityDisclosureAgreementSignedDate":1440076476617,
  ],  "serviceReasonIdshomeCampus":{  :
      [{"id" : "d95ea029901e104b-90c14dc7-4be043f5-b547a38e-8054fc6914b7581015e204e1"},
      {"idname" :"North "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"}Campus",
     ...
    ],
 "confidentialityLevelsobjectStatus" :"ACTIVE"
null,   },
"permissions" : null,  "currentProgramStatusNameformattedCDACompleteDate" : "Active2015-08-20",
   "registeredForCurrentTermformattedStudentIntakeCompleteDate" : true
}n

 

Delete a Person

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

...

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

PDF Report - To be completed by Unicon