Versions Compared

Old Version 49

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",
 "results" : "100",  "rows" : 
    [{"id" : "58ba5ee3d77f4697-734eed36-4ae94477-b9c5b8d0-943774b4de4167c9a1d8b2db",
  
   "createdDate" : 13312692000001356998400000,
      "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 Administrator"Doe"},
   },
   "objectStatus" : "ACTIVE",
  
   "firstName" : "SallyJames",
      "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" : "amydemo@trainingssp.advisor@university.educom",

         "workPhone" : "(123777) 456777-78907777",
  
       "officeLocation":null,
:  "123 Benton Hall Room A"departmentName":null,
   
      "departmentNamehomeCampusName" :"West Campus"Engineering,
& Applied Science" 		   "photoUrl":"http://192.168.0.151:8080/images/0000000.png"},null
       "strengths" : "Good test taker",
 },
    "abilityToBenefit" : true,
  
   "anticipatedStartTerm" : "Fall",
      "anticipatedStartYear" : "2012"2011,
      "actualStartTerm":"FallFA2011",
      "actualStartYear":20122011,
   "studentIntakeRequestDate":1440076505197,
   "studentIntakeRequestDatespecialServiceGroups":[ : 
1331269200000,      { "specialServiceGroups" : 
         [{"id" : "437f6f2b856a3600-7b1e1326-47b411e2-86039b79-9e1208605c0d406c8f22c3ce",
		   "name" : "Basketball Team",	
		      "name":"Student Athlete",
         "objectStatus" : "ACTIVE"}
         ]},
      "referralSources"{ : 
         [{"id" : "a8c83fd40a640a2a-ee33409d-46ee1271-8d898140-9b2956696f37d0c138a100fd",
		
         "name":"DEI :Focus "Counseling Services".
		Group",
         "objectStatus" : "ACTIVE"},
      }
   ],
   "referralSources":[  
"serviceReasons" :      {  
         [{"id" : "d95ea029859ff107-90c11326-4be011e2-b5478698-8054fc6914b7406c8f22c3ce"},
		         "name" : "DevelopmentalStudent EducationConduct",
		         "objectStatus" : "ACTIVE"
      },
      {  
  ],       "confidentialityLevelsid" : null,:"858b0cab-1326-11e2-818e-406c8f22c3ce",
         "name"permissions:"HS :Guidance nullCounselor",
         "currentProgramStatusNameobjectStatus" : "ActiveACTIVE",
      },
  "registeredForCurrentTerm" : true  {  
  "activeAlertsCount":1,       "closedAlertsCountid":2,"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "paymentStatusname":"YFaculty / YStaff YReferral",
         "registeredTermsobjectStatus":"ACTIVE"2013FA
  2013SP 2013SU" 	  "residencyCounty":"Butler",
	},
      {  
         "f1Statusid":"Yccadd634-bd7a-11e1-8d28-3368721922dc",
	
         "gendername":"MOmbudsman",
	
         "maritalStatusobjectStatus":"Single",
	  "ethnicity":null,
	  "actionPlanTaskOpenCount":4,
	  "actionPlanTaskClosedCount":15,
	  "lastActionPlanCompletedDate":1367297284590} 
	]
}

 

Get All Persons Who Are Coaches

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

Info

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

GET /ssp/api/1/person/coach

Security

PERSON_READ

...

Returns

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "firstName" : "Camden",
      "lastName" : "Coach"},
     {"id" : "63d62297-bf08-496f-acf3-0c129d437c2b",
      "firstName" : "Christina",
      "lastName" : "Coach"},
      ...
    ]
}

 

Get a Person

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

Security

PERSON_READ

Returns

Person

Code Block
    [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "createdDate" : 1331269200000,
      "createdBy" :
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
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",
         "firstNameobjectStatus" : "JohnACTIVE",
      }
   "lastName" : "Doe"}, 
  ],
   "modifiedDatereferralSources":[ : 
1331269200000,      { "modifiedBy" :
         {"id" : "91f46e39859ff107-cea81326-422b11e2-b2158698-00f6bcf5d280406c8f22c3ce",
          "firstNamename" :"Student Conduct"John",
          "lastNameobjectStatus" : "DoeACTIVE"},
      },
"objectStatus" : "ACTIVE",    {  
"firstName" : "Sally",       "middleNameid" : null,
      "lastName" : "Student",:"858b0cab-1326-11e2-818e-406c8f22c3ce",
         "name"birthDate:"HS :Guidance nullCounselor",
         "primaryEmailAddressobjectStatus" : "sally.student@university.eduACTIVE",
      "secondaryEmailAddress" : null,},
      {  
"username" : "sally.student",       "homePhoneid" : "123-456-7890",f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "name"workPhone:"Faculty / :Staff nullReferral",
         "objectStatus":"cellPhoneACTIVE"
: null,      },
      {  
"nonLocalAddress" : null,       "addressLine1id" : "444 West Third Street",:"ccadd634-bd7a-11e1-8d28-3368721922dc",
         "addressLine2name":"Ombudsman",
:  null,       "cityobjectStatus" : "DaytonACTIVE",
      "state" : "OH",}
   ],
   "zipCodeserviceReasons" :[ "45402", 
     "alternateAddressLineInUse" :{ null, 
     "alternateAddressLine1" : null,       "alternateAddressLine2" : null,"id":"0a640a2a-409d-1271-8140-d0b3878000f6",
         "alternateAddressCityname" :"Scholarship nullRecipient",
         "alternateAddressStateobjectStatus" :"ACTIVE"
null,      },
"alternateAddressZipCode" : null,    {  
"alternateAddressCountry" : null,       "photoUrl" : null,"id":"85709794-1326-11e2-8bab-406c8f22c3ce",
         "schoolIdname" :"Academically nullUnprepared",
         "enabledobjectStatus" :"ACTIVE"
false,      },
"studentIntakeCompleteDate" : null,    {   "studentType" :
         {"id" : "ce0d041df6201a04-d3acbb31-42a14ca5-9085b606-7f744240e07e609f3ad09f87",

         "name" : "EarlyAt-Risk AlertStudent",
          "objectStatus":"ACTIVE"},},
      },
      {  
         "coach" :"id":"205df6c0-fea0-11e1-9678-406c8f22c3ce",
         {"idname" :"Career "91f46e39-cea8-422b-b215-00f6bcf5d280"Coaching",
          "firstNameobjectStatus" : "AmyACTIVE",
      }
   ],
 "lastName" : "AdvisorconfidentialityLevels":null,
   "permissions":null,
   "currentProgramStatusName":"Active",
   "primaryEmailAddressprogramStatusChangeReasonName":null,
  : "amy.advisor@university.edu"registeredForCurrentTerm":false,
   "activeAlertsCount":2,
   "closedAlertsCount":1,
   "workPhoneresidencyCounty" : "(123) 456-7890"DemoCounty",
   "f1Status":"Y",
   "gender":"M",
   "officeLocationmaritalStatus" : "Separated"123,
Benton Hall Room A"ethnicity":null,
      "race":null,
   "departmentNameactionPlanTaskOpenCount" :1,
"Engineering & Applied Science"
		"actionPlanTaskClosedCount":4,
   "photoUrl":"http://192.168.0.151:8080/images/0000000.png"}lastActionPlanCompletedDate":1440076479537,
   "confidentialityDisclosureAgreementSignedDate":1440076476617,
   "strengthshomeCampus" :{ "Good test taker",
      "abilityToBenefitid" : true:"901e104b-4dc7-43f5-a38e-581015e204e1",
      "anticipatedStartTermname" :"North Campus"Fall",
      "anticipatedStartYearobjectStatus" : "2012ACTIVE",
   },
   "actualStartTermformattedCDACompleteDate":"Fall2015-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
 { "actualStartYearfirstName":2012"James",
 
    "studentIntakeRequestDatemiddleName" : 1331269200000,
  "Jacob",
   "specialServiceGroupslastName" :"Anderson",
      "birthDate":"1986-10-24",
   [{"idprimaryEmailAddress" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"demo@trainingssp.com",
		   "namesecondaryEmailAddress" : "Basketball Team",	
		   "objectStatususername" : "ACTIVEjanderson218"},
   "homePhone":"(555) 555-5412",
    ]"workPhone":"",
   "cellPhone":"",
   "referralSourcesalternatePhone" ::"212-555-1212",
   "nonLocalAddress":false,
      [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
		"addressLine1":"321 W. Demo St.",
   "nameaddressLine2" : "CounselingApt. Services214".,
		   "objectStatuscity" : "ACTIVEPhoenix"},
   "state":"AZ",
   "zipCode":"55555  ],   ",
   "serviceReasonsalternateAddressInUse" :false,
   "alternateAddressLine1":"",
   "alternateAddressLine2":"",
   [{"idalternateAddressCity" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		   "namealternateAddressState" :" "Developmental Education",
		   "objectStatus" : "ACTIVE"}
 alternateAddressZipCode":"          ",
   "alternateAddressCountry":"",
   ]"photoUrl":null,
   "schoolId":"janderson218",
   "confidentialityLevelsenabled" : nulltrue,
    "studentIntakeCompleteDate":null,
   "permissionsstudentType":{ : null,
      "currentProgramStatusNameid" : "Active"0a640a2a-409d-1271-8140-d0af4a4200ef",
      "registeredForCurrentTermname" : true"Non-Degree Seeking",
      "activeAlertsCountobjectStatus":1,"ACTIVE"
   },
   "closedAlertsCountcoach":2,{  
      "paymentStatusid":"Y Y Y22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "registeredTermsfirstName":"Demo"2013FA,
  2013SP 2013SU" 	  "residencyCountylastName":"ButlerCoach13",
 	  "f1Status":"Y", 	  "genderprimaryEmailAddress":"Mdemo@trainingssp.com",
  	    "maritalStatusworkPhone":"Single(777) 777-7777",
	   "ethnicity":null, 	  "actionPlanTaskOpenCountofficeLocation":4null,
 	  "actionPlanTaskClosedCount":15, 	  "lastActionPlanCompletedDate":1367297284590} 
	]
}

 

Get a Person by School ID

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

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

Security

PERSON_READ

Returns

Person

Code Block
    [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "createdDate" : 1331269200000,
      "createdBy" :departmentName":null,
      "homeCampusName":"West Campus",
      "photoUrl":null
   },
   "abilityToBenefit":true,
   "anticipatedStartTerm":"",
   "anticipatedStartYear":2011,
   "actualStartTerm":"FA2011",
   "actualStartYear":2011,
   "studentIntakeRequestDate":1440076505197,
   "specialServiceGroups":[  
      {  
         {"id" : "91f46e39856a3600-cea81326-422b11e2-b2159b79-00f6bcf5d280406c8f22c3ce",

         "firstNamename" :"Student "JohnAthlete",
          "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : 1331269200000,},
      { "modifiedBy" :
         {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0c138a100fd",
          "name"firstName:"DEI :Focus Group"John",

         "lastNameobjectStatus" : "Doe"},ACTIVE"
      }
   ],
   "objectStatusreferralSources":[  
:  "ACTIVE",    {  
"firstName" : "Sally",       "middleName" : null,"id":"859ff107-1326-11e2-8698-406c8f22c3ce",
         "lastNamename" : "Student Conduct",
         "birthDateobjectStatus" :"ACTIVE"
null,      },
"primaryEmailAddress" : "sally.student@university.edu",    {  
"secondaryEmailAddress" : null,       "usernameid" : "sally.student"858b0cab-1326-11e2-818e-406c8f22c3ce",
         "name"homePhone:"HS :Guidance Counselor"123-456-7890",
      "workPhone" : null   "objectStatus":"ACTIVE"
      },
      {  
"cellPhone" : null,       "nonLocalAddress" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "addressLine1name" : "444Faculty West/ ThirdStaff StreetReferral",
         "addressLine2objectStatus" :"ACTIVE"
null,      },
"city" : "Dayton",    {  
"state" : "OH",       "zipCodeid" : "45402","ccadd634-bd7a-11e1-8d28-3368721922dc",
         "name"alternateAddressLineInUse:"Ombudsman",
:  null,       "alternateAddressLine1objectStatus" : null,
      "alternateAddressLine2"ACTIVE"
: null,     }
 "alternateAddressCity" : null],
  
   "alternateAddressStateserviceReasons" : null,
 [  
  "alternateAddressZipCode" : null,    {  
"alternateAddressCountry" : null,       "photoUrl" : null,id":"0a640a2a-409d-1271-8140-d0b3878000f6",
         "schoolIdname" :"Scholarship nullRecipient",
         "enabledobjectStatus" :"ACTIVE"
false,      },
"studentIntakeCompleteDate" : null,    {  
"studentType" :
         {"id" : "ce0d041d85709794-d3ac1326-42a111e2-90858bab-7f744240e07e406c8f22c3ce",
          "name" : "EarlyAcademically AlertUnprepared",
          "objectStatus":"ACTIVE"
      },},
      { "coach" :
         {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",

         "firstNamename" :"At-Risk Student"Amy",

         "lastNameobjectStatus" : "AdvisorACTIVE",
      },
     "primaryEmailAddress" : "amy.advisor@university.edu",{  
         "workPhoneid" : "(123) 456-7890",
"205df6c0-fea0-11e1-9678-406c8f22c3ce",
         "officeLocationname" :"Career Coaching"123,
Benton Hall Room A",      "objectStatus":"ACTIVE"
     "departmentName" }
: "Engineering & Applied],
Science" 		  "photoUrl":"http://192.168.0.151:8080/images/0000000.png"}confidentialityLevels":null,
   "permissions":null,
   "currentProgramStatusName"strengths:"Active",
: "Good test taker"programStatusChangeReasonName":null,
   "registeredForCurrentTerm":false,
   "abilityToBenefitactiveAlertsCount" : true2,
   "closedAlertsCount":1,
   "anticipatedStartTermresidencyCounty" : "FallDemoCounty",
   "f1Status":"Y",
   "anticipatedStartYeargender" : "2012M",
   "maritalStatus":"Separated",
   "actualStartTermethnicity":"Fall"null,
   "race":null,
   "actualStartYearactionPlanTaskOpenCount":20121,
   "actionPlanTaskClosedCount":4,
   "studentIntakeRequestDatelastActionPlanCompletedDate" :1440076479537,
1331269200000,   "confidentialityDisclosureAgreementSignedDate":1440076476617,
   "specialServiceGroupshomeCampus" : 
{  
      [{"id" : "437f6f2b901e104b-7b1e4dc7-47b443f5-8603a38e-9e1208605c0d581015e204e1",
		      "name" : "BasketballNorth TeamCampus",	
   		   "objectStatus" : "ACTIVE"}
         ],
},
     "referralSourcesformattedCDACompleteDate" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"2015-08-20",
		   "nameformattedStudentIntakeCompleteDate" : "Counseling Services".
		:null
}

Returns

Person

Code Block
{  
   "objectStatusid" : "ACTIVE"}:"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
         ]"createdDate":1356998400000,
      "serviceReasonscreatedBy" :{  
        [{"id" : "d95ea02922fc02f1-90c1d8b6-4be0496c-b5478e2d-8054fc6914b765f6973f888e"},
		      "namefirstName" : "Developmental EducationDemo",
		      "objectStatuslastName" : "ACTIVECoach13"},
      "fullName":"Demo Coach13"
  ] },
   "modifiedDate":1444021202117,
   "confidentialityLevels" : null,  modifiedBy":{  
      "id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "permissionsfirstName" : null"System",
      "currentProgramStatusNamelastName" : "ActiveAdministrator",
      "registeredForCurrentTermfullName":"System :Administrator"
true   },
   "activeAlertsCountobjectStatus":1"ACTIVE",
   "firstName":"James",
   "closedAlertsCountmiddleName":2"Jacob",
   "lastName":"Anderson",
   "paymentStatusbirthDate":"Y Y Y1986-10-24",
 
    "registeredTermsprimaryEmailAddress":"2013FA 2013SP 2013SU"
	demo@trainingssp.com",
   "residencyCountysecondaryEmailAddress":"Butler",
	   "f1Statususername":"Yjanderson218",
	   "genderhomePhone":"M(555) 555-5412",
	   "maritalStatusworkPhone":"Single",
 	  "cellPhone":"ethnicity":null,
 	  "actionPlanTaskOpenCountalternatePhone":4"212-555-1212",
	   "actionPlanTaskClosedCountnonLocalAddress":15false,
 	  "lastActionPlanCompletedDateaddressLine1":1367297284590}"321 W. 	]
}

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",
  Demo St.",
   "addressLine2":"Apt. 214",
   "middleNamecity" : null,
  "Phoenix",
   "lastNamestate" : "StudentAZ",
   "zipCode":"55555   "birthDate" : null",
   "alternateAddressInUse":false,
   "primaryEmailAddressalternateAddressLine1" : "sally.student@university.edu",

     "secondaryEmailAddressalternateAddressLine2" : null,
  "",
   "usernamealternateAddressCity" : "sally.student",
      "homePhone"alternateAddressState":" : "123-456-7890",
      "workPhonealternateAddressZipCode" :" null,       "cellPhone" : null",
   "alternateAddressCountry":"",
   "nonLocalAddressphotoUrl" : null,
  
   "addressLine1schoolId" : "444 West Third Street"janderson218",
  
   "addressLine2enabled" : nulltrue,
 
    "citystudentIntakeCompleteDate" : "Dayton",
  null,
   "statestudentType":{ : "OH",
      "zipCodeid" : "45402"0a640a2a-409d-1271-8140-d0af4a4200ef",
      "alternateAddressLineInUsename" : null"Non-Degree Seeking",
      "alternateAddressLine1objectStatus" :"ACTIVE"
null,   },
   "alternateAddressLine2coach":{ : null,
      "alternateAddressCityid" : null:"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "alternateAddressStatefirstName" : null"Demo",
      "alternateAddressZipCodelastName" : null"Coach13",
      "alternateAddressCountryprimaryEmailAddress" : null:"demo@trainingssp.com",
      "photoUrlworkPhone" : null"(777) 777-7777",
      "schoolIdofficeLocation" : null,
      "enableddepartmentName" : falsenull,
      "studentIntakeCompleteDatehomeCampusName" :"West nullCampus",
      "studentTypephotoUrl" :null
   },
   "abilityToBenefit":true,
 {  "idanticipatedStartTerm" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
    "anticipatedStartYear":2011,
     "nameactualStartTerm" : "Early AlertFA2011",
   "actualStartYear":2011,
   "studentIntakeRequestDate":1440076505197,
   "objectStatusspecialServiceGroups":"ACTIVE"},},[  
      { "coach" :
         {"id" : "91f46e39856a3600-cea81326-422b11e2-b2159b79-00f6bcf5d280406c8f22c3ce",

         "firstNamename" :"Student Athlete"Amy",
          "lastNameobjectStatus" : "AdvisorACTIVE",
      },
     "primaryEmailAddress" : "amy.advisor@university.edu",{  
         "workPhoneid" : "(123) 456-7890"0a640a2a-409d-1271-8140-d0c138a100fd",
          "officeLocationname" : "123DEI Benton Hall Room AFocus Group",
          "departmentNameobjectStatus" : "Engineering & Applied Science"
		  "photoUrl":"http://192.168.0.151:8080/images/0000000.png"},"ACTIVE"
      }
"strengths" : "Good test taker" ],
   "referralSources":[  
"abilityToBenefit" : true,    {  
"anticipatedStartTerm" : "Fall",       "anticipatedStartYearid" : "2012","859ff107-1326-11e2-8698-406c8f22c3ce",
         "actualStartTermname":"FallStudent Conduct",
         "actualStartYearobjectStatus":2012,"ACTIVE"
      "studentIntakeRequestDate" : 1331269200000},
      "specialServiceGroups"{ : 
         [{"id" : "437f6f2b858b0cab-7b1e1326-47b411e2-8603818e-9e1208605c0d406c8f22c3ce",
		
         "name":"HS Guidance Counselor",
  "name" : "Basketball Team",	 		   "objectStatus" : "ACTIVE"}
         ]},
      "referralSources"{ : 
         [{"id" : "a8c83fd4f6201a04-ee33bb31-46ee4ca5-8d89b606-9b2956696f37609f3ad09f87",
		         "name":"Faculty / :Staff "Counseling Services".
		Referral",
         "objectStatus" : "ACTIVE"},
         ]},
      "serviceReasons"{ : 
         [{"id" : "d95ea029ccadd634-90c1bd7a-4be011e1-b5478d28-8054fc6914b73368721922dc"},
		
         "name" : "Developmental Education",
		":"Ombudsman",
         "objectStatus" : "ACTIVE"}
      }
   ],
      "confidentialityLevelsserviceReasons":[  :
null,      {  
"permissions" : null,       "currentProgramStatusNameid" : "Active"0a640a2a-409d-1271-8140-d0b3878000f6",
       "registeredForCurrentTerm" : true  "name":"Scholarship Recipient",
         "activeAlertsCountobjectStatus":1,"ACTIVE"
      "closedAlertsCount":2,},
      {  "paymentStatus":"Y Y Y",
         "registeredTermsid":"2013FA 2013SP 2013SU"
	  "residencyCounty":"Butler",
	  "f1Status":"Y",
	  "gender":"M",
	  "maritalStatus":"Single",
	  "ethnicity":null,
	  "actionPlanTaskOpenCount":4,
	  "actionPlanTaskClosedCount":15,
	  "lastActionPlanCompletedDate":1367297284590} 
	]
}

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41","85709794-1326-11e2-8bab-406c8f22c3ce",
         "name":"Academically Unprepared",
         "objectStatus":"ACTIVE"
      },
      {  
         "id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "name":"At-Risk Student",
         "objectStatus":"createdDateACTIVE"
: 1331269200000,      },
      { "createdBy" :
         {"id" : "91f46e39205df6c0-cea8fea0-422b11e1-b2159678-00f6bcf5d280406c8f22c3ce",

         "firstNamename" :"Career Coaching"John",
          "lastNameobjectStatus" : "DoeACTIVE"},
      }
 "modifiedDate" : 1331269200000],
  
   "modifiedByconfidentialityLevels" :null,
    "permissions":null,
    {"idcurrentProgramStatusName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Active",
   "programStatusChangeReasonName":null,
   "registeredForCurrentTerm":false,
   "firstNameactiveAlertsCount" : "John",
 2,
    "closedAlertsCount":1,
   "lastNameresidencyCounty" : "DoeDemoCounty"},
   "f1Status":"Y",
   "objectStatusgender" : "ACTIVEM",
  
   "firstNamemaritalStatus" : "SallySeparated",
   "ethnicity":null,
   "middleNamerace" : null,
  
   "lastNameactionPlanTaskOpenCount" : "Student",
  1,
   "birthDateactionPlanTaskClosedCount" : null4,

     "primaryEmailAddresslastActionPlanCompletedDate" : "sally.student@university.edu":1440076479537,
      "secondaryEmailAddressconfidentialityDisclosureAgreementSignedDate" : null1440076476617,
  
   "usernamehomeCampus":{ : "sally.student",
      "homePhoneid" : "123-456-7890901e104b-4dc7-43f5-a38e-581015e204e1",
      "workPhonename" :"North nullCampus",
      "cellPhoneobjectStatus" :"ACTIVE"
null,   },
   "nonLocalAddressformattedCDACompleteDate" : null,
:"2015-08-20",
     "addressLine1formattedStudentIntakeCompleteDate" : "444 West Third Street",
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
{  
   "addressLine2id" : null,
  :"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
   "citycreatedDate" : "Dayton",
  1356998400000,
   "statecreatedBy":{ : "OH",
      "zipCodeid" : "45402"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "alternateAddressLineInUsefirstName" : null,
      "alternateAddressLine1" : null"Demo",
      "alternateAddressLine2lastName" : null,
      "alternateAddressCity" : null"Coach13",
      "alternateAddressStatefullName" : null,
      "alternateAddressZipCode" : null,"Demo Coach13"
   },
   "alternateAddressCountrymodifiedDate" : null1444021202117,
 
    "photoUrlmodifiedBy":{ : null,
      "schoolIdid" : null:"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "enabledfirstName" : false"System",
      "studentIntakeCompleteDatelastName" : null"Administrator",
      "studentTypefullName" :"System Administrator"
    },
   {"idobjectStatus" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"ACTIVE",
   "firstName":"James",
   "middleName":"Jacob",
   "namelastName" : "Early AlertAnderson",
      "birthDate":"1986-10-24",
   "objectStatusprimaryEmailAddress":"ACTIVE"},}demo@trainingssp.com",
      "coachsecondaryEmailAddress" :"",
     "username":"janderson218",
   {"idhomePhone" : "91f46e39-cea8-422b-b215-00f6bcf5d280"(555) 555-5412",
   "workPhone":"",
      "firstNamecellPhone" : "Amy",

         "lastName" : "Advisor"alternatePhone":"212-555-1212",
   "nonLocalAddress":false,
      "primaryEmailAddressaddressLine1" :"321 "amy.advisor@university.eduW. Demo St.",
      "addressLine2":"Apt. 214",
   "workPhonecity" : "(123) 456-7890"Phoenix",
      "state":"AZ",
   "officeLocationzipCode" :"55555 "123 Benton Hall Room A",
   "alternateAddressInUse":false,
      "departmentNamealternateAddressLine1" : ""Engineering,
& Applied Science" 		  "photoUrlalternateAddressLine2":"http://192.168.0.151:8080/images/0000000.png"},
   "alternateAddressCity":"",
   "strengthsalternateAddressState" : "Good test taker",
 
    "abilityToBenefitalternateAddressZipCode" : true,"       "anticipatedStartTerm" : "Fall",   ",
   "anticipatedStartYearalternateAddressCountry" : "2012",
   "photoUrl":null,
   "actualStartTermschoolId":"Falljanderson218",
      "actualStartYearenabled":2012true,
      "studentIntakeRequestDatestudentIntakeCompleteDate" : 1331269200000null,
 
    "specialServiceGroupsstudentType" :{  
        [{"id" : "437f6f2b0a640a2a-7b1e409d-47b41271-86038140-9e1208605c0dd0af4a4200ef",
		      "name" : "BasketballNon-Degree TeamSeeking",	
   		   "objectStatus" : "ACTIVE"}
         ]},
      "referralSourcescoach" : 
{  
      [{"id" : "a8c83fd422fc02f1-ee33d8b6-46ee496c-8d898e2d-9b2956696f3765f6973f888e",
 		     "firstName":"nameDemo",
: "Counseling Services". 		   "objectStatuslastName" : "ACTIVECoach13"},
         ]"primaryEmailAddress":"demo@trainingssp.com",
      "serviceReasons" :"workPhone":"(777) 777-7777",
      "officeLocation":null,
    [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		departmentName":null,
      "namehomeCampusName" : "DevelopmentalWest EducationCampus",
		      "objectStatusphotoUrl":null
: "ACTIVE"}  },
   "abilityToBenefit":true,
   ],"anticipatedStartTerm":"",
   "anticipatedStartYear":2011,
   "confidentialityLevelsactualStartTerm" : null"FA2011",
    "actualStartYear":2011,
   "permissionsstudentIntakeRequestDate" : null1440076505197,
   "specialServiceGroups":[  
"currentProgramStatusName" : "Active",    {  
"registeredForCurrentTerm" : true       "activeAlertsCountid":1"856a3600-1326-11e2-9b79-406c8f22c3ce",
      "closedAlertsCount":2,
      "paymentStatusname":"YStudent Y YAthlete",
      "registeredTerms":"2013FA 2013SP 2013SU"
	  "residencyCountyobjectStatus":"ButlerACTIVE",
 	  "f1Status":"Y", 	  "gender":"M",
	  "maritalStatus":"Single",
	  "ethnicity":null,
	  "actionPlanTaskOpenCount":4,
	  "actionPlanTaskClosedCount":15,
	  "lastActionPlanCompletedDate":1367297284590} 
	]
}

 

Save a Person

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

Security

PERSON_WRITE

Note

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

Sample Post

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",},
      {  
         "id":"0a640a2a-409d-1271-8140-d0c138a100fd",
         "createdDatename":"DEI :Focus 1331269200000Group",
         "createdByobjectStatus" :"ACTIVE"
       }
 {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", ],
   "referralSources":[  
     "firstName" :{ "John", 
         "lastNameid" : "Doe"}"859ff107-1326-11e2-8698-406c8f22c3ce",
         "modifiedDatename" :"Student 1331269200000Conduct",
         "modifiedByobjectStatus" :
 "ACTIVE"
       {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  },
      {  
         "firstNameid" : "John"858b0cab-1326-11e2-818e-406c8f22c3ce",
          "name"lastName:"HS :Guidance "DoeCounselor"},
         "objectStatus" : "ACTIVE",
      "firstName" : "Sally",},
      {  
"middleName" : null,       "lastNameid" : "Student"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "birthDate" : null,name":"Faculty / Staff Referral",
         "primaryEmailAddressobjectStatus" : "sally.student@university.eduACTIVE",
      "secondaryEmailAddress" : null,},
      {  
"username" : "sally.student",       "homePhoneid" : "123-456-7890",ccadd634-bd7a-11e1-8d28-3368721922dc",
         "name":"workPhoneOmbudsman",
 : null,       "cellPhoneobjectStatus":"ACTIVE"
: null,     }
 "nonLocalAddress" : null],
 
    "addressLine1serviceReasons":[ : "444
West Third Street",    {  
"addressLine2" : null,       "cityid" : "Dayton"0a640a2a-409d-1271-8140-d0b3878000f6",
         "statename" :"Scholarship Recipient"OH",
         "zipCodeobjectStatus" : "45402ACTIVE",
      },
"alternateAddressLineInUse" : null,    {  
"alternateAddressLine1" : null,       "alternateAddressLine2" : null,"id":"85709794-1326-11e2-8bab-406c8f22c3ce",
         "alternateAddressCityname" :"Academically nullUnprepared",
         "alternateAddressStateobjectStatus" :"ACTIVE"
null,      },
"alternateAddressZipCode" : null,    {  
"alternateAddressCountry" : null,       "photoUrl" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "schoolIdname" : null,"At-Risk Student",
         "enabledobjectStatus" :"ACTIVE"
false,       "studentIntakeCompleteDate" : null,},
      {  "studentType" :
         {"id" : "ce0d041d205df6c0-d3acfea0-42a111e1-90859678-7f744240e07e406c8f22c3ce",

         "name" : "EarlyCareer AlertCoaching"
,
         "objectStatus":"ACTIVE"
      },}
   ],
   "confidentialityLevels":null,
   "permissions":null,
   "coach" :currentProgramStatusName":"Active",
   "programStatusChangeReasonName":null,
   "registeredForCurrentTerm":false,
   "activeAlertsCount":2,
   {"idclosedAlertsCount":1,
   "residencyCounty":"DemoCounty",
   "91f46e39-cea8-422b-b215-00f6bcf5d280"f1Status":"Y",
     "gender":"M",
    "firstNamemaritalStatus" : "AmySeparated",
   "ethnicity":null,
   "race":null,
   "lastNameactionPlanTaskOpenCount":1,
:   "AdvisoractionPlanTaskClosedCount":4,
   "lastActionPlanCompletedDate":1440076479537,
   "confidentialityDisclosureAgreementSignedDate":1440076476617,
   "primaryEmailAddresshomeCampus" : "amy.advisor@university.edu",
{  
        "workPhoneid" : "(123) 456-7890",
"901e104b-4dc7-43f5-a38e-581015e204e1",
         "officeLocationname" :"North Campus"123,
 Benton Hall Room A",  "objectStatus":"ACTIVE"
    },
   "departmentNameformattedCDACompleteDate" : "Engineering & Applied Science"
		:"2015-08-20",
   "photoUrl":"http://192.168.0.151:8080/images/0000000.png"},formattedStudentIntakeCompleteDate":null
}

Returns

Person

Code Block
{  
     "strengthsid" : "Good test taker"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
   "createdDate":1356998400000,
   "abilityToBenefitcreatedBy":{ : true,
      "anticipatedStartTermid" : "Fall"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "anticipatedStartYearfirstName" : "2012Demo",
      "actualStartTermlastName":"FallCoach13",
      "actualStartYearfullName":2012,"Demo Coach13"
   },
   "studentIntakeRequestDatemodifiedDate" : 13312692000001444021202117,
      "specialServiceGroupsmodifiedBy" :{  
        [{"id" : "437f6f2b58ba5ee3-7b1e734e-47b44ae9-8603b9c5-9e1208605c0d943774b4de41",
		      "namefirstName" : "Basketball TeamSystem",	
   		   "objectStatuslastName" : "ACTIVE"}
         ]Administrator",
      "referralSourcesfullName" :"System Administrator"
   },
     [{"idobjectStatus" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"ACTIVE",
		   "namefirstName" : "Counseling ServicesJames".,
		   "objectStatusmiddleName" : "ACTIVEJacob"},
   "lastName":"Anderson",
     ],
  "birthDate":"1986-10-24",
   "serviceReasonsprimaryEmailAddress" :"demo@trainingssp.com",
     "secondaryEmailAddress":"",
    [{"idusername" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}"janderson218",
		   "namehomePhone" : "Developmental Education(555) 555-5412",
		   "objectStatusworkPhone" : "ACTIVE"},
   "cellPhone":"",
     ],"alternatePhone":"212-555-1212",
   "nonLocalAddress":false,
   "confidentialityLevelsaddressLine1":"321 : nullW. Demo St.",
   "addressLine2":"Apt. 214",
   "permissionscity" : null"Phoenix",
      "currentProgramStatusNamestate" : "ActiveAZ",
      "registeredForCurrentTerm" : true"zipCode":"55555     ",
   "activeAlertsCountalternateAddressInUse":1false,
   "alternateAddressLine1":"",
   "closedAlertsCountalternateAddressLine2":2"",
   "alternateAddressCity":"",
   "paymentStatusalternateAddressState":"Y Y Y",
  
   "registeredTermsalternateAddressZipCode":"2013FA      2013SP 2013SU" 	  "residencyCounty":"Butler",
	   "f1StatusalternateAddressCountry":"Y",
 	  "genderphotoUrl":"M"null,
 	  "maritalStatusschoolId":"Singlejanderson218",
 	  "ethnicityenabled":nulltrue,
 	  "actionPlanTaskOpenCountstudentIntakeCompleteDate":4null,
 	  "actionPlanTaskClosedCountstudentType":15,
	{  
   "lastActionPlanCompletedDate":1367297284590}  	] }

Returns

Person

Code Block
{"id" : "58ba5ee30a640a2a-734e409d-4ae91271-b9c58140-943774b4de41d0af4a4200ef",
      "createdDatename" : 1331269200000"Non-Degree Seeking",
      "objectStatus":"createdByACTIVE"
   },
   "coach":{  
       {"id" : "91f46e3922fc02f1-cea8d8b6-422b496c-b2158e2d-00f6bcf5d28065f6973f888e",
   
      "firstName" : "JohnDemo",
      "lastName":"Coach13",
      "lastNameprimaryEmailAddress" : "Doedemo@trainingssp.com"}, 
      "modifiedDateworkPhone" : 1331269200000"(777) 777-7777",
      "modifiedByofficeLocation" ::null,
      "departmentName":null,
      {"idhomeCampusName" :"West "91f46e39-cea8-422b-b215-00f6bcf5d280"Campus",
      "photoUrl":null
   },
"firstName"  : "JohnabilityToBenefit":true,
   "anticipatedStartTerm":"",
   "anticipatedStartYear":2011,
   "actualStartTerm":"lastNameFA2011",
  : "DoeactualStartYear"}:2011,
   "studentIntakeRequestDate":1440076505197,
   "objectStatusspecialServiceGroups":[  : "ACTIVE",
      {  
"firstName" : "Sally",       "middleName" : null,"id":"856a3600-1326-11e2-9b79-406c8f22c3ce",
         "lastNamename" : "Student Athlete",
         "birthDateobjectStatus" :"ACTIVE"
null,      },
"primaryEmailAddress" : "sally.student@university.edu",    {  
"secondaryEmailAddress" : null,       "usernameid" : "sally.student","0a640a2a-409d-1271-8140-d0c138a100fd",
         "name"homePhone:"DEI : "123-456-7890Focus Group",
         "objectStatus"workPhone:"ACTIVE"
: null,     }
 "cellPhone" : null],
  
   "nonLocalAddressreferralSources":[ : null,
      "addressLine1"{ : "444
West Third Street",       "addressLine2" : null,id":"859ff107-1326-11e2-8698-406c8f22c3ce",
         "cityname" :"Student "DaytonConduct",
         "stateobjectStatus" : "OHACTIVE",
      },
"zipCode" : "45402",    {  
"alternateAddressLineInUse" : null,       "alternateAddressLine1" : null,"id":"858b0cab-1326-11e2-818e-406c8f22c3ce",
         "name"alternateAddressLine2:"HS :Guidance nullCounselor",
         "alternateAddressCityobjectStatus" :"ACTIVE"
null,      },
"alternateAddressState" : null,    {  
"alternateAddressZipCode" : null,       "alternateAddressCountry" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "photoUrlname" :"Faculty null,/ Staff Referral",
    "schoolId" : null,
      "enabledobjectStatus" :"ACTIVE"
false,       "studentIntakeCompleteDate" : null,},
      { "studentType" :
         {"id" : "ce0d041dccadd634-d3acbd7a-42a111e1-90858d28-7f744240e07e3368721922dc",

         "name" : "Early AlertOmbudsman",
          "objectStatus":"ACTIVE"},},
      }
   ],
   "coachserviceReasons" :[  
       {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstNameid" : "Amy"0a640a2a-409d-1271-8140-d0b3878000f6",
          "lastNamename" :"Scholarship Recipient"Advisor",

         "primaryEmailAddressobjectStatus" : "amy.advisor@university.edu",ACTIVE"
      },
    "workPhone" : "(123) 456-7890",{  
         "officeLocationid" : "123 Benton Hall Room A",
"85709794-1326-11e2-8bab-406c8f22c3ce",
         "departmentNamename" : "Engineering & Applied Science"
		  "photoUrl":"http://192.168.0.151:8080/images/0000000.png"},Academically Unprepared",
         "strengthsobjectStatus" : "ACTIVE"Good
test taker",     },
 "abilityToBenefit" : true,   {  
 "anticipatedStartTerm" : "Fall",
      "anticipatedStartYearid" : "2012"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "actualStartTermname":"FallAt-Risk Student",
         "actualStartYearobjectStatus":2012,"ACTIVE"
      "studentIntakeRequestDate" : 1331269200000},
      "specialServiceGroups"{ : 
         [{"id" : "437f6f2b205df6c0-7b1efea0-47b411e1-86039678-9e1208605c0d406c8f22c3ce",
		
  "name" : "Basketball Team",	 		   "objectStatusname" :"Career Coaching"ACTIVE"},
         ],"objectStatus":"ACTIVE"
      "referralSources" :}
   ],
      [{"idconfidentialityLevels" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37":null,
		   "namepermissions" : "Counseling Services".
		null,
   "objectStatuscurrentProgramStatusName" : "ACTIVEActive"},
     
   ]"programStatusChangeReasonName":null,
   "registeredForCurrentTerm":false,
   "serviceReasonsactiveAlertsCount" :2,
    "closedAlertsCount":1,
     [{"idresidencyCounty" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}"DemoCounty",
		   "namef1Status" : "Developmental EducationY",
		   "objectStatusgender" : "ACTIVEM"},
         ],
  "maritalStatus":"Separated",
   "confidentialityLevelsethnicity" : null,
        "permissionsrace" : null,
  
   "currentProgramStatusNameactionPlanTaskOpenCount" : "Active",
  1,
   "registeredForCurrentTermactionPlanTaskClosedCount" : true
  :4,
   "activeAlertsCountlastActionPlanCompletedDate":11440076479537,
      "closedAlertsCountconfidentialityDisclosureAgreementSignedDate":21440076476617,
      "paymentStatushomeCampus":"Y{ Y Y",
      "registeredTermsid":"2013FA 2013SP 2013SU"
	  "residencyCounty":"Butler",
	  "f1Status":"Y",
	  "gender":"M",
	  "maritalStatus":"Single",
	  "ethnicity":null,
	  "actionPlanTaskOpenCount":4,
	  "actionPlanTaskClosedCount":15,
	  "lastActionPlanCompletedDate":1367297284590} 
	]
}"901e104b-4dc7-43f5-a38e-581015e204e1",
      "name":"North Campus",
      "objectStatus":"ACTIVE"
   },
   "formattedCDACompleteDate":"2015-08-20",
   "formattedStudentIntakeCompleteDate":n

 

Delete a Person

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

...