Versions Compared

Old Version 47

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. 

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

...

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
{"success" : "true  
   "id":"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
 "results" : "100createdDate":1356998400000,
   "rowscreatedBy":{ : 
      [{"id" : "58ba5ee322fc02f1-734ed8b6-4ae9496c-b9c58e2d-943774b4de4165f6973f888e",
      "createdDatefirstName" : 1331269200000"Demo",
      "createdBylastName" :"Coach13",
         {"idfullName" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe""Demo Coach13"
   },
       "modifiedDate" : 13312692000001444021202117,
 
    "modifiedBy" :
{  
      {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
          "firstName" : "JohnSystem",
 
        "lastName" : "DoeAdministrator"},
       "objectStatusfullName" :"System Administrator"ACTIVE",
   },
   "firstNameobjectStatus" : "SallyACTIVE",
   "firstName":"James",
   "middleName" : 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" :"55555 "45402",    ",
   "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" : "EarlyNon-Degree AlertSeeking"
 ,
        "objectStatus":"ACTIVE"},},
   },
   "coach" :{  
       {"id" : "91f46e3922fc02f1-cea8d8b6-422b496c-b2158e2d-00f6bcf5d28065f6973f888e",
 
        "firstName" : "AmyDemo",

         "lastName" : "AdvisorCoach13",
          "primaryEmailAddress" : "amy.advisor@university.edu",
   "primaryEmailAddress":"demo@trainingssp.com",
      "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" : "2012"2011,
      "actualStartTerm":"FallFA2011",

     "actualStartYear":20122011,
      "studentIntakeRequestDate" : 1331269200000,1440076505197,
   "specialServiceGroups":[  
      { "specialServiceGroups" : 
         [{"id" : "437f6f2b856a3600-7b1e1326-47b411e2-86039b79-9e1208605c0d406c8f22c3ce",
		
         "name" : "BasketballStudent TeamAthlete",	
		
         "objectStatus" : "ACTIVE"}
         ]},
      "referralSources"{ : 
         [{"id" : "a8c83fd40a640a2a-ee33409d-46ee1271-8d898140-9b2956696f37d0c138a100fd",
		   "name" : "Counseling Services". 		   "name"objectStatus:"DEI :Focus "ACTIVEGroup"},
         "objectStatus":"ACTIVE"
      }
   ],
   "referralSources":[  
   "serviceReasons" :   {  
         [{"id" : "d95ea029859ff107-90c11326-4be011e2-b5478698-8054fc6914b7406c8f22c3ce"},
		         "name" : "DevelopmentalStudent EducationConduct",
		
         "objectStatus" : "ACTIVE"}
      },
  ],     {  "confidentialityLevels" :
null,         "permissionsid" : null,:"858b0cab-1326-11e2-818e-406c8f22c3ce",
       "currentProgramStatusName" : "Activename":"HS Guidance Counselor",
       "registeredForCurrentTerm" : true  "objectStatus":"ACTIVE"
      },
      {  
 "activeAlertsCount":1,        "closedAlertsCountid":2"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "paymentStatusname":"YFaculty / YStaff YReferral",
         "registeredTermsobjectStatus":"2013FA 2013SP 2013SU"}"ACTIVE"
      },
      {  
   ]
}

 

Get All Persons Who Are Coaches

This method calls the corresponding uPlatform API to obtain those individuals assigned the Coach group.   

Info

For performance reasons, this result set is populated by a background job that by default runs every 5m.  The background job and known issues with user attribute caching in uPortal affect how quickly the coach list in uPortal is updated.

GET /ssp/api/1/person/coach

Security

PERSON_READ

...

Returns

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" :       "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" : "CamdenSystem",
      "lastName":"Administrator",
      "fullName":"System "Coach"Administrator"
   },
 
   {"idobjectStatus" : "63d62297-bf08-496f-acf3-0c129d437c2b"ACTIVE",
      "firstName" : "ChristinaJames",
   "middleName":"Jacob",
   "lastName" : "CoachAnderson"},
      ...
    ]
}

 

Get a Person

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

Security

PERSON_READ

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280"birthDate":"1986-10-24",
   "primaryEmailAddress":"demo@trainingssp.com",
   "secondaryEmailAddress":"",
   "username":"janderson218",
   "homePhone":"(555) 555-5412",
     "firstNameworkPhone" : "John",
     "lastNamecellPhone" : "Doe"},
  "modifiedDate" : 1331269200000, "alternatePhone":"212-555-1212",
   "modifiedBynonLocalAddress" :false,
    {"addressLine1"id:"321 W. :Demo "91f46e39-cea8-422b-b215-00f6bcf5d280",
St.",
    "firstNameaddressLine2" :"Apt. "John214",
 
   "lastNamecity" : "DoePhoenix"},
   "objectStatusstate" : "ACTIVEAZ",
   "firstNamezipCode" :"55555 "Sally",  "middleInitial" : null",
 "lastName" : "StudentalternateAddressInUse":false,
 "birthDate" : null,
 "primaryEmailAddressalternateAddressLine1" : "sally.student@university.edu",
 "secondaryEmailAddress"
: null,  "usernamealternateAddressLine2" : "sally.student",
   "homePhonealternateAddressCity" : "123-456-7890",
   "workPhonealternateAddressState" : null,"  "cellPhone",
: null,  "nonLocalAddressalternateAddressZipCode":" :  null,  "addressLine1" : "444 West Third Street",
   "addressLine2alternateAddressCountry" : null"",
 "city" : "DaytonphotoUrl":null,
   "stateschoolId" : "OHjanderson218",
 "zipCode" : "45402enabled":true,
   "alternateAddressLineInUsestudentIntakeCompleteDate" : null,
   "alternateAddressLine1studentType":{  :
null,  "alternateAddressLine2" : null,  "alternateAddressCityid" : null,
 "alternateAddressState" : null,:"0a640a2a-409d-1271-8140-d0af4a4200ef",
      "alternateAddressZipCodename" : null"Non-Degree Seeking",
 "alternateAddressCountry"  : null,  "photoUrlobjectStatus" : null,
 "schoolIdACTIVE"
: null,  "enabled"},
: false,  "studentIntakeCompleteDatecoach" :{ null, 
"coach" :     {"id" : "91f46e3922fc02f1-cea8d8b6-422b496c-b2158e2d-00f6bcf5d28065f6973f888e",
      "firstName" : "AmyDemo",
      "lastName" : "AdvisorCoach13",
      "primaryEmailAddress" : "amydemo@trainingssp.advisor@university.educom",
      "workPhone" : "(123777) 456777-78907777",
      "officeLocation":null,
:  "123 Benton Hall Room A"departmentName":null,
      "departmentNamehomeCampusName" :"West Campus"Engineering,
  & Applied Science"},  "strengthsphotoUrl":null
: "Good test taker"},
   "abilityToBenefit" : true,
   "anticipatedStartTerm" : "Fall",
   "anticipatedStartYear":2011,
: "2012",  "actualStartTerm":"FallFA2011",
   "actualStartYear":20122011,
    "studentType" :studentIntakeRequestDate":1440076505197,
   "specialServiceGroups":[  
      {  
         "id" : "ce0d041d856a3600-d3ac1326-42a111e2-90859b79-7f744240e07e406c8f22c3ce",
         "name" :"Student "Early Alert"},
 "studentIntakeRequestDate" : 1331269200000,
 "specialServiceGroups" :Athlete",
         "objectStatus":"ACTIVE"
      },
      {  
         [{"id" : "437f6f2b0a640a2a-7b1e409d-47b41271-86038140-9e1208605c0dd0c138a100fd",
	          "name" :"DEI "BasketballFocus TeamGroup",	
		
         "objectStatus" : "ACTIVE"}
      }
   ],
   "referralSources" ::[  
      {  
         [{"id" : "a8c83fd4859ff107-ee331326-46ee11e2-8d898698-9b2956696f37406c8f22c3ce",
		
         "name" :"Student "Counseling Services".
		Conduct",
         "objectStatus" : "ACTIVE"},
      },
    ],  "serviceReasons"{ : 
         [{"id" : "d95ea029858b0cab-90c11326-4be011e2-b547818e-8054fc6914b7406c8f22c3ce"},
		         "name" :"HS "DevelopmentalGuidance EducationCounselor",
		         "objectStatus" : "ACTIVE"
      },
      {  
      ],   "confidentialityLevels" : null,id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
     "permissions" : null,  "currentProgramStatusName" : "Active",
 "registeredForCurrentTerm" : true
 "activeAlertsCount":1,
 "closedAlertsCount":2,
 "paymentStatus":"Y Y Y",
 "registeredTerms":"2013FA 2013SP 2013SU"
}

 

Get a Person by School ID

Selects a single person by their school id.  The school id is typically the person's unique institutional id stored in the ERP system.

GET /ssp/api/1/person/bySchoolId/{schoolId}

Security

PERSON_READ

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",name":"Faculty / Staff Referral",
         "objectStatus":"ACTIVE"
      },
      {  
         "id":"ccadd634-bd7a-11e1-8d28-3368721922dc",
         "firstNamename" : "JohnOmbudsman",
         "lastNameobjectStatus" : "Doe"}ACTIVE"
      }
   ],
   "modifiedDateserviceReasons" :[ 1331269200000, 
"modifiedBy" :     {  
         "id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0b3878000f6",
         "firstNamename" :"Scholarship "JohnRecipient",
     "lastName" : "Doe"},   "objectStatus" : "ACTIVE",
 "firstName" : "Sally",  "middleInitial" :},
null,  "lastName" : "Student",  "birthDate"{ : null,
 "primaryEmailAddress" : "sally.student@university.edu",  "secondaryEmailAddress" : null,  "usernameid" : "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,
 "studentIntakeCompleteDate" : null,
 "enabled" : false,
 "coach" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280"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",
     "firstName" : "Amy",
     "lastNamename" :"Career Coaching"Advisor",
     "primaryEmailAddress" : "amy.advisor@university.edu",      "workPhoneobjectStatus" : "(123) 456-7890","ACTIVE"
     "officeLocation" : "123 Benton Hall}
Room A",  ],
   "departmentNameconfidentialityLevels" :null,
"Engineering & Applied Science"permissions"}:null,
   "strengthscurrentProgramStatusName" : "Active"Good,
test taker",  "abilityToBenefitprogramStatusChangeReasonName" : truenull,
 "anticipatedStartTerm" : "FallregisteredForCurrentTerm":false,
 "anticipatedStartYear" : "2012activeAlertsCount":2,
   "actualStartTermclosedAlertsCount":"Fall"1,
   "actualStartYearresidencyCounty":2012,
 "studentTypeDemoCounty" :
,
   {"idf1Status" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"Y",
     "namegender" : "Early AlertM"},
   "maritalStatus":"studentIntakeRequestDateSeparated",
: 1331269200000,  "specialServiceGroupsethnicity" :null,
   "race":null,
      [{"idactionPlanTaskOpenCount" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d":1,
   "actionPlanTaskClosedCount":4,
   "lastActionPlanCompletedDate":1440076479537,
   "nameconfidentialityDisclosureAgreementSignedDate" : "Basketball Team":1440076476617,
   "homeCampus":{  
         "objectStatusid" : "ACTIVE"}"901e104b-4dc7-43f5-a38e-581015e204e1",
         ],
 "referralSources" : 
  "name":"North Campus",
      [{"idobjectStatus" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37","ACTIVE"
       },
   "nameformattedCDACompleteDate" : "Counseling Services"."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
{  
   "objectStatusid" : "ACTIVE"}"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
     "createdDate":1356998400000,
   ],
 "serviceReasonscreatedBy" :{  
        [{"id" : "d95ea02922fc02f1-90c1d8b6-4be0496c-b5478e2d-8054fc6914b765f6973f888e"},
           "namefirstName" : "Developmental EducationDemo",
  
        "objectStatuslastName" : "ACTIVE"}
         ],
 "confidentialityLevels" : null"Coach13",
   "permissions" : null,  "currentProgramStatusNamefullName" : "Active",Demo  Coach13"registeredForCurrentTerm"
: true  "activeAlertsCount":1,},
   "closedAlertsCountmodifiedDate":21444021202117,
   "paymentStatusmodifiedBy":"Y Y Y",{  
      "registeredTermsid":"2013FA 2013SP 2013SU"
}

Create a Person

POST /ssp/api/1/person

Security

PERSON_WRITE

Note

Properties currentAppointmentStartDate and currentProgramStatusName are helper properties and are not saved if specified.  Call the respective Person Appointment and Person Program Status services to save these entries.

Sample Post

Code Block
{"firstName" : "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",
     "firstName" : "Amy",
     "lastName" : "Advisor",
     "primaryEmailAddress" : "amy.advisor@university.edu",
     "workPhone" : "(123) 456-789058ba5ee3-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",
      "officeLocationname" : "123 Benton Hall Room ANon-Degree Seeking",
      "departmentNameobjectStatus" :"ACTIVE"
"Engineering & Applied Science"},
   "strengthscoach" :{ "Good test
taker",  "abilityToBenefit" : true,  "anticipatedStartTermid" : "Fall","22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "anticipatedStartYearfirstName" : "2012Demo",
      "actualStartTermlastName":"FallCoach13",
      "actualStartYearprimaryEmailAddress":2012"demo@trainingssp.com",
 "studentType" :     {"idworkPhone" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"(777) 777-7777",
      "nameofficeLocation":null,
:   "Early Alert"},  "studentIntakeRequestDatedepartmentName" :null,
1331269200000,  "specialServiceGroups" :   "homeCampusName":"West Campus",
      [{"idphotoUrl" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",null
    },
   "abilityToBenefit":true,
   "nameanticipatedStartTerm" : "Basketball Team",
   "anticipatedStartYear":2011,
   "actualStartTerm":"FA2011",
   "actualStartYear":2011,
   "objectStatusstudentIntakeRequestDate" :1440076505197,
"ACTIVE"}   "specialServiceGroups":[  
    ],  "referralSources"{ : 
         [{"id" : "a8c83fd4856a3600-ee331326-46ee11e2-8d899b79-9b2956696f37406c8f22c3ce",
           "name" : "CounselingStudent ServicesAthlete".
 ,
         "objectStatus" : "ACTIVE"},
      },
  ],    "serviceReasons"{ : 
         [{"id" : "d95ea0290a640a2a-90c1409d-4be01271-b5478140-8054fc6914b7d0c138a100fd"},
 
         "name" :"DEI "DevelopmentalFocus EducationGroup",
           "objectStatus" : "ACTIVE"}
      }
   ],
   "confidentialityLevelsreferralSources" :[ null, 
  "permissions" : null,  "currentProgramStatusName"{ : "Active",
 "registeredForCurrentTerm" : null  "activeAlertsCount":1,  "closedAlertsCount":2,  "paymentStatusid":"Y Y Y859ff107-1326-11e2-8698-406c8f22c3ce",
 "registeredTerms":"2013FA 2013SP 2013SU"
}

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",        "createdDatename" :"Student 1331269200000Conduct",
   "createdBy" :     {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280","ACTIVE"
      },
      "firstName" : "John",{  
         "lastNameid" : "Doe"}"858b0cab-1326-11e2-818e-406c8f22c3ce",
  "modifiedDate" : 1331269200000,
 "modifiedBy" :       "name":"HS Guidance Counselor",
         {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280","ACTIVE"
      },
 "firstName" : "John",   {  
"lastName" : "Doe"},   "objectStatus" : "ACTIVE",  "firstNameid" : "Sally"f6201a04-bb31-4ca5-b606-609f3ad09f87",
 "middleInitial" : null,  "lastName" : "Student",  "birthDatename" :"Faculty null,/ Staff "primaryEmailAddress" : "sally.student@university.edu"Referral",
 "secondaryEmailAddress" : null,  "username" : "sally.student",  "homePhoneobjectStatus" : "123-456-7890",
 "workPhone" : null,
 "cellPhone" : null,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "nonLocalAddress" : null,
 "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"ACTIVE"
      },
      {  
         "id":"ccadd634-bd7a-11e1-8d28-3368721922dc",
         "name":"Ombudsman",
         "objectStatus":"ACTIVE"
      }
   ],
   "serviceReasons":[  
      {  
         "id":"0a640a2a-409d-1271-8140-d0b3878000f6",
         "firstNamename" :"Scholarship Recipient"Amy",
         "lastNameobjectStatus" : "Advisor",ACTIVE"
      },
      {  
 "primaryEmailAddress" : "amy.advisor@university.edu",      "workPhone" : "(123) 456-7890",id":"85709794-1326-11e2-8bab-406c8f22c3ce",
         "officeLocationname" :"Academically Unprepared"123,
Benton Hall Room A",      "departmentName" : "Engineering & Applied Science"objectStatus":"ACTIVE"
      },
 "strengths" : "Good test taker", { "abilityToBenefit" :
true,  "anticipatedStartTerm" : "Fall",  "anticipatedStartYear" : "2012",  "actualStartTermid":"Fallf6201a04-bb31-4ca5-b606-609f3ad09f87",
 "actualStartYear":2012,  "studentType" :     {"idname" : "ce0d041d-d3ac-42a1-9085-7f744240e07e","At-Risk Student",
         "objectStatus":"nameACTIVE"
 :    "Early Alert"},
 "studentIntakeRequestDate"  : 1331269200000,  "specialServiceGroupIds"{ : 
         [{"id" : "437f6f2b205df6c0-7b1efea0-47b411e1-86039678-9e1208605c0d406c8f22c3ce",
 
         "name" : "BasketballCareer TeamCoaching",    
 
         "objectStatus" : "ACTIVE"}
      }
   ],
   "referralSourceIdsconfidentialityLevels" : 
     :null,
   [{"idpermissions" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
       :null,
   "namecurrentProgramStatusName" : "Counseling ServicesActive".,
   "programStatusChangeReasonName":null,
   "registeredForCurrentTerm":false,
   "objectStatusactiveAlertsCount" : "ACTIVE"}2,
   "closedAlertsCount":1,
   "residencyCounty":"DemoCounty",
 ],  "serviceReasonIdsf1Status" :"Y",
     "gender":"M",
    [{"idmaritalStatus" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}"Separated",
   "ethnicity":null,
   "race":null,
   "nameactionPlanTaskOpenCount":1,
:   "Developmental EducationactionPlanTaskClosedCount":4,
   "lastActionPlanCompletedDate":1440076479537,
   "confidentialityDisclosureAgreementSignedDate":1440076476617,
   "objectStatushomeCampus" : "ACTIVE"}
 :{  
     ],  "confidentialityLevelsid" : null:"901e104b-4dc7-43f5-a38e-581015e204e1",
   "permissions" : null,  "currentProgramStatusNamename" :"North Campus"Active",
  "registeredForCurrentTerm" : true  "activeAlertsCountobjectStatus":1,
 "closedAlertsCountACTIVE":2,
 "paymentStatus":"Y Y Y"},
   "registeredTermsformattedCDACompleteDate":"2013FA 2013SP 2013SU"
}

 

Save a Person

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

Security

PERSON_WRITE

Note

Properties currentAppointmentStartDate and currentProgramStatusName are helper properties and are not saved if specified.  Call the respective Person Appointment and Person Program Status services to save these entries.

Sample Post

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d2802015-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",
      "firstNamelastName" : "JohnCoach13",
      "lastNamefullName" :"Demo "Doe"Coach13"
   },
   "modifiedDate":1444021202117,
: 1331269200000,  "modifiedBy":{ : 
      {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
      "firstName" : "JohnSystem",
      "lastName":"Administrator",
      "fullName":"System "Doe"Administrator"
   },
   "objectStatus" : "ACTIVE",
   "firstName" : "SallyJames",
 "middleInitial" : null,  "middleName":"Jacob",
   "lastName" : "StudentAnderson",
   "birthDate":"1986-10-24",
: null,  "primaryEmailAddress" : "sallydemo@trainingssp.student@university.educom",
   "secondaryEmailAddress":"",
: null,  "username" : "sally.studentjanderson218",
   "homePhone" : "123-456-7890","(555) 555-5412",
   "workPhone":"",
: null,  "cellPhone":"",
   "alternatePhone": null,"212-555-1212",
   "nonLocalAddress":false,
: null,  "addressLine1" :"321 "444W. West Third StreetDemo St.",
   "addressLine2" :"Apt. null214",
   "city" : "DaytonPhoenix",
   "state" : "OHAZ",
   "zipCode" ::"55555     "45402",
   "alternateAddressLineInUsealternateAddressInUse":false,
: null,  "alternateAddressLine1":"",
: null,  "alternateAddressLine2":"",
: null,  "alternateAddressCity":"",
: null,  "alternateAddressState":" : null",
   "alternateAddressZipCode" : null:"          ",
   "alternateAddressCountry":"",
: null,  "photoUrl" : null,
   "schoolId":"janderson218",
: null,  "enabled"":true,
: false,  "studentIntakeCompleteDate" : null,
   "coachstudentType":{  
 :     {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0af4a4200ef",
      "firstNamename" :"Non-Degree Seeking"Amy",
      "lastNameobjectStatus" : "AdvisorACTIVE",
     "primaryEmailAddress" : "amy.advisor@university.edu"},
     "workPhonecoach":{ : "(123)
456-7890",      "officeLocationid" : "123 Benton Hall Room A",
     "departmentName" : "Engineering & Applied Science"},
 "strengths" : "Good test taker",
 "abilityToBenefit" : true,
 "anticipatedStartTerm" : "Fall",
 "anticipatedStartYear" : "2012",
 "actualStartTerm":"Fall",
 "actualStartYear":2012,
 "studentType" :"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "firstName":"Demo",
      "lastName":"Coach13",
      "primaryEmailAddress":"demo@trainingssp.com",
      {"idworkPhone" : "ce0d041d-d3ac-42a1-9085-7f744240e07e","(777) 777-7777",
      "nameofficeLocation":null,
  : "Early Alert"},  "studentIntakeRequestDatedepartmentName" : 1331269200000null,

"specialServiceGroups" :     "homeCampusName":"West Campus",
    [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",photoUrl":null
   },
   "abilityToBenefit":true,
   "nameanticipatedStartTerm" : "Basketball Team",
   "anticipatedStartYear":2011,
   "actualStartTerm":"FA2011",
   "actualStartYear":2011,
   "objectStatusstudentIntakeRequestDate" :1440076505197,
"ACTIVE"}   "specialServiceGroups":[  
    ],  "referralSources"{ : 
         [{"id" : "a8c83fd4856a3600-ee331326-46ee11e2-8d899b79-9b2956696f37406c8f22c3ce",
           "name" : "CounselingStudent ServicesAthlete".
 ,
         "objectStatus" : "ACTIVE"},
      },
    ],  "serviceReasons"{ : 
         [{"id" : "d95ea0290a640a2a-90c1409d-4be01271-b5478140-8054fc6914b7d0c138a100fd"},
           "name" :"DEI "DevelopmentalFocus EducationGroup",
           "objectStatus" : "ACTIVE"}
      }
   ],
 "confidentialityLevels" : null,  
 "permissions" : null,
 "currentProgramStatusName" : "Active",
 "registrationStatusForCurrentTerm" : true

}

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :"referralSources":[  
      {  
         {"id" : "91f46e39859ff107-cea81326-422b11e2-b2158698-00f6bcf5d280406c8f22c3ce",
         "firstNamename" :"Student Conduct"John",
         "lastNameobjectStatus" : "Doe"ACTIVE"
      },
    "modifiedDate" : 1331269200000,
 "modifiedBy" :  {  
         {"id" : "91f46e39858b0cab-cea81326-422b11e2-b215818e-00f6bcf5d280406c8f22c3ce",
         "firstName" : "John","name":"HS Guidance Counselor",
         "objectStatus":"ACTIVE"
     "lastName" : "Doe"},
      "objectStatus"{ : "ACTIVE",
 "firstName" : "Sally",  "middleInitial" : null,  "lastNameid" : "Student"f6201a04-bb31-4ca5-b606-609f3ad09f87",
 "birthDate" : null,  "primaryEmailAddress" : "sally.student@university.edu",  "name"secondaryEmailAddress:"Faculty : null/ Staff Referral",
 "username" : "sally.student",  "homePhone" : "123-456-7890",  "workPhoneobjectStatus" : null,
 "cellPhoneACTIVE"
:  null,  "nonLocalAddress" : null},
   "addressLine1" : "444 West{ Third Street",
 "addressLine2" : null,  "city" : "Dayton",  "stateid" : "OH"ccadd634-bd7a-11e1-8d28-3368721922dc",
 "zipCode" : "45402",  "alternateAddressLineInUse" : null,  "alternateAddressLine1name" : null"Ombudsman",
 "alternateAddressLine2" : null,  "alternateAddressCity" : null,  "alternateAddressStateobjectStatus" :"ACTIVE"
null,  "alternateAddressZipCode" : null,  "alternateAddressCountry" : null,}
   ],
   "photoUrlserviceReasons" :[ null, 
"schoolId" : null,  "studentIntakeCompleteDate" : null,{  "enabled"
: false,  "coach" :     {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0b3878000f6",
     "firstName" : "Amy",
     "lastNamename" :"Scholarship Recipient"Advisor",
     "primaryEmailAddress" : "amy.advisor@university.edu",      "workPhoneobjectStatus" : "(123) 456-7890",
"ACTIVE"
    "officeLocation" : "123 Benton Hall Room A"},
     "departmentName" :{ "Engineering &
Applied Science"},  "strengths" : "Good test taker",  "abilityToBenefitid" : true:"85709794-1326-11e2-8bab-406c8f22c3ce",
 "anticipatedStartTerm" : "Fall",  "anticipatedStartYear" : "2012",  "actualStartTermname":"FallAcademically Unprepared",
 "actualStartYear":2012,  "studentType" :     {"idobjectStatus" : "ce0d041d-d3ac-42a1-9085-7f744240e07e","ACTIVE"
     "name" : "Early Alert"},
 "studentIntakeRequestDate"  : 1331269200000,  "specialServiceGroups"{ : 
         [{"id" : "437f6f2bf6201a04-7b1ebb31-47b44ca5-8603b606-9e1208605c0d609f3ad09f87",
 
         "name" : "BasketballAt-Risk TeamStudent",    
 
         "objectStatus" : "ACTIVE"}
      },
   ],   "referralSources"{ : 
         [{"id" : "a8c83fd4205df6c0-ee33fea0-46ee11e1-8d899678-9b2956696f37406c8f22c3ce",

          "name" :"Career "Counseling Services".Coaching",
         "objectStatus":"ACTIVE"
      }
   ],
   "confidentialityLevels":null,
   "permissions":null,
   "currentProgramStatusName":"objectStatusActive",
  : "ACTIVEprogramStatusChangeReasonName"}:null,
   "registeredForCurrentTerm":false,
   "activeAlertsCount":2,
 ],  "serviceReasonsclosedAlertsCount" :1,
   "residencyCounty":"DemoCounty",
   "f1Status":"Y",
   [{"idgender" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}"M",
   "maritalStatus":"Separated",
   "ethnicity":null,
   "namerace":null,
:   "Developmental EducationactionPlanTaskOpenCount":1,
   "actionPlanTaskClosedCount":4,
    "lastActionPlanCompletedDate":1440076479537,
   "objectStatusconfidentialityDisclosureAgreementSignedDate" :1440076476617,
"ACTIVE"}   "homeCampus":{  
    ],  "confidentialityLevelsid" : null:"901e104b-4dc7-43f5-a38e-581015e204e1",
   "permissions" : null,  "currentProgramStatusNamename" :"North "ActiveCampus",
 "registeredForCurrentTerm"  : true  "activeAlertsCountobjectStatus":1"ACTIVE"
   },
 "closedAlertsCount":2,  "paymentStatusformattedCDACompleteDate":"Y Y Y","2015-08-20",
   "registeredTermsformattedStudentIntakeCompleteDate":"2013FA 2013SP 2013SU"
}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