Versions Compared

Old Version 54

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" : "DoeCoach13"},
      "fullName":"Demo Coach13"modifiedDate"
  : 1331269200000},
   "modifiedDate":1444021202117,
   "modifiedBy" :
{  
      {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
          "firstName" : "JohnSystem",
      "lastName":"Administrator",
      "lastNamefullName" :"System "DoeAdministrator"},
   },
   "objectStatus" : "ACTIVE",

     "firstName" : "SallyJames",

     "middleName" : null,
  "Jacob",
   "lastName" : "StudentAnderson",
      "birthDate" : "19831986-0810-2024",
  
   "primaryEmailAddress" : "sallydemo@trainingssp.student@university.educom",
  
   "secondaryEmailAddress" : null"",
      "username" : "sally.studentjanderson218",
  
   "homePhone" : "123-456-7890"(555) 555-5412",
      "workPhone" : null"",
      "cellPhone" :"",
null,   "alternatePhone":"212-555-1212",
   "nonLocalAddress" : nullfalse,
      "addressLine1" : "444321 WestW. ThirdDemo StreetSt.",
  
   "addressLine2" :"Apt. null214",
      "city" : "DaytonPhoenix",
      "state" : "OHAZ",
  
   "zipCode" : "45402","55555     ",
   "alternateAddressLineInUsealternateAddressInUse" : nullfalse,
      "alternateAddressLine1" : null,
  "",
   "alternateAddressLine2" : null,
  "",
   "alternateAddressCity" : null"",

     "alternateAddressState":" : null",
      "alternateAddressZipCode" :" null,       "alternateAddressCountry" : null",
   "alternateAddressCountry":"",
   "photoUrl" : null,
      "schoolId" : null"janderson218",

     "enabled" : falsetrue,

     "studentIntakeCompleteDate" : null,
  
   "studentType" :
{  
      {"id" : "ce0d041d0a640a2a-d3ac409d-42a11271-90858140-7f744240e07ed0af4a4200ef",
   
      "name" :"Non-Degree "Early Alert"
 Seeking",
        "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"}, 
      "strengths" : "Good test taker"null
   },
      "abilityToBenefit" : true,
 
    "anticipatedStartTerm" : "Fall",
  
   "anticipatedStartYear" : "2012",
  2011,
   "actualStartTerm":"FallFA2011",
      "actualStartYear":20122011,
   "studentIntakeRequestDate":1440076505197,
   "studentIntakeRequestDatespecialServiceGroups":[  :
1331269200000,      { "specialServiceGroups" : 
         [{"id" : "437f6f2b856a3600-7b1e1326-47b411e2-86039b79-9e1208605c0d406c8f22c3ce",
		
         "name" : "BasketballStudent TeamAthlete",	
		
         "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",
         "permissionsname":"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"ACTIVE"
      }
   ],
	   "ethnicityserviceReasons":null,[ 	 
"actionPlanTaskOpenCount":4, 	  "actionPlanTaskClosedCount":15, 	  "lastActionPlanCompletedDate":1367297284590{  
    "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

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "firstName" : "Camden   "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",
      "lastName" : "Coach"},   "name":"DEI Focus Group",
         {"idobjectStatus" : "63d62297-bf08-496f-acf3-0c129d437c2b","ACTIVE"
      "firstName"}
: "Christina",   ],
   "lastNamereferralSources":[  :
 "Coach"},     {  ...
    ] }

 

Get a Person

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

Security

PERSON_READ

Returns

Person

Code Block
    [{"id" : "58ba5ee3859ff107-734e1326-4ae911e2-b9c5-943774b4de41",8698-406c8f22c3ce",
         "name":"Student Conduct",
         "objectStatus":"createdDateACTIVE"
  :    1331269200000},
      { "createdBy" :
         {"id" : "91f46e39858b0cab-cea81326-422b11e2-b215818e-00f6bcf5d280406c8f22c3ce",
          "name"firstName:"HS :Guidance "JohnCounselor",
          "lastNameobjectStatus" : "DoeACTIVE"},
      },
"modifiedDate" : 1331269200000,    {  
"modifiedBy" :          {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",
          "name"firstName:"Faculty / :Staff Referral"John",

         "lastNameobjectStatus" : "DoeACTIVE"},
       "objectStatus" : "ACTIVE",},
      {  
"firstName" : "Sally",       "middleName" : null,id":"ccadd634-bd7a-11e1-8d28-3368721922dc",
         "lastNamename" : "StudentOmbudsman",
         "birthDateobjectStatus" : "1983-08-20",ACTIVE"
      }
 "primaryEmailAddress" : "sally.student@university.edu" ],
   "serviceReasons":[  
"secondaryEmailAddress" : null,    {  
"username" : "sally.student",       "homePhoneid" : "123-456-78900a640a2a-409d-1271-8140-d0b3878000f6",
        "workPhone" : null, "name":"Scholarship Recipient",
         "cellPhoneobjectStatus" :"ACTIVE"
null,       "nonLocalAddress" : null},
      "addressLine1"{ : "444
West Third Street",       "addressLine2" : null,"id":"85709794-1326-11e2-8bab-406c8f22c3ce",
         "cityname" :"Academically "DaytonUnprepared",
         "stateobjectStatus" : "OHACTIVE",
      "zipCode" : "45402",},
      {  
"alternateAddressLineInUse" : null,       "alternateAddressLine1" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "alternateAddressLine2" : null,"name":"At-Risk Student",
         "alternateAddressCityobjectStatus" :"ACTIVE"
null,      },
"alternateAddressState" : null,    {  
"alternateAddressZipCode" : null,       "alternateAddressCountry" : null,"id":"205df6c0-fea0-11e1-9678-406c8f22c3ce",
         "photoUrlname" :"Career nullCoaching",
         "objectStatus":"schoolIdACTIVE"
: null,     }
 "enabled" : false],
 
    "studentIntakeCompleteDateconfidentialityLevels" : null,
 
    "studentTypepermissions" :null,
   "currentProgramStatusName":"Active",
   "programStatusChangeReasonName":null,
 {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"registeredForCurrentTerm":false,
   "activeAlertsCount":2,
   "closedAlertsCount":1,
   "nameresidencyCounty" : "DemoCounty"Early,
Alert"   "f1Status":"Y",
   "gender":"M",
   "objectStatusmaritalStatus":"ACTIVESeparated"},},
   "ethnicity":null,
   "coachrace" :null,
   "actionPlanTaskOpenCount":1,
   "actionPlanTaskClosedCount":4,
   {"idlastActionPlanCompletedDate":1440076479537,
 :  "91f46e39-cea8-422b-b215-00f6bcf5d280"confidentialityDisclosureAgreementSignedDate":1440076476617,
   "homeCampus":{  
      "firstNameid" : "Amy",
  :"901e104b-4dc7-43f5-a38e-581015e204e1",
       "lastNamename" :"North Campus"Advisor",
 
        "primaryEmailAddressobjectStatus" : "amy.advisor@university.eduACTIVE",
      },
   "workPhoneformattedCDACompleteDate" : "(123) 456-7890"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",
   "officeLocationmiddleName" : "Jacob"123,
Benton Hall Room A",
       "lastName":"Anderson",
   "departmentNamebirthDate" : "Engineering & Applied Science"
		:"1986-10-24",
   "photoUrlprimaryEmailAddress":"http://192.168.0.151:8080/images/0000000.png"}, 
  demo@trainingssp.com",
   "strengthssecondaryEmailAddress" : "Good test taker",
 
    "abilityToBenefitusername" : true,
 "janderson218",
    "anticipatedStartTermhomePhone" : "Fall"(555) 555-5412",
  
   "anticipatedStartYearworkPhone" : "2012",

     "actualStartTermcellPhone":"Fall",
 
    "actualStartYearalternatePhone":2012,
  "212-555-1212",
   "studentIntakeRequestDatenonLocalAddress" : 1331269200000false,
 
    "specialServiceGroupsaddressLine1" :"321 W. Demo  St.",
      [{"idaddressLine2" :"Apt. "437f6f2b-7b1e-47b4-8603-9e1208605c0d"214",
		   "namecity" : "Basketball TeamPhoenix",	
		   "objectStatusstate" : "ACTIVE"}
         ]AZ",
      "referralSources" :"zipCode":"55555     ",
   "alternateAddressInUse":false,
   [{"idalternateAddressLine1" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
		   "namealternateAddressLine2" : "Counseling Services".,
		   "objectStatusalternateAddressCity" : "ACTIVE"},
   "alternateAddressState":"      ]",
    "alternateAddressZipCode":"  "serviceReasons" :       ",
   [{"idalternateAddressCountry" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		   "namephotoUrl" : "Developmental Education":null,
		   "objectStatusschoolId" : "ACTIVE"}
         ],
  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",
	      "f1StatusprimaryEmailAddress":"Ydemo@trainingssp.com",
	   "gender":"M", 	  "maritalStatusworkPhone":"Single(777) 777-7777",
	      "ethnicityofficeLocation":null,
    	  "actionPlanTaskOpenCountdepartmentName":4null,
	   "actionPlanTaskClosedCount":15, 	  "lastActionPlanCompletedDatehomeCampusName":1367297284590"West Campus",
      "formattedStudentIntakeCompleteDatephotoUrl":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
 },
   [{"idabilityToBenefit":true,
   "anticipatedStartTerm":"",
   "58ba5ee3-734e-4ae9-b9c5-943774b4de41"anticipatedStartYear":2011,
   "actualStartTerm":"FA2011",
   "createdDateactualStartYear" :2011,
1331269200000,   "studentIntakeRequestDate":1440076505197,
   "createdBy" :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" : "DoeACTIVE"},
      }
"objectStatus"  : "ACTIVE"],
   "referralSources":[  
"firstName" : "Sally",    {  
"middleName" : null,       "lastNameid" : "Student","859ff107-1326-11e2-8698-406c8f22c3ce",
         "birthDatename" : "1983-08-20"Student Conduct",
         "primaryEmailAddressobjectStatus" : "sally.student@university.edu",ACTIVE"
      },
"secondaryEmailAddress" : null,    {  
"username" : "sally.student",       "homePhoneid" : "123-456-7890",858b0cab-1326-11e2-818e-406c8f22c3ce",
         "name"workPhone:"HS :Guidance nullCounselor",
         "cellPhoneobjectStatus" : null,:"ACTIVE"
      "nonLocalAddress" : null},
      "addressLine1"{ : "444
West Third Street",       "addressLine2" : null,id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "cityname" : "Dayton",Faculty / Staff     "state" : "OH",Referral",
         "zipCodeobjectStatus" : "45402ACTIVE",
      "alternateAddressLineInUse"},
: null,     {  "alternateAddressLine1"
 : null,       "alternateAddressLine2" : null,"id":"ccadd634-bd7a-11e1-8d28-3368721922dc",
         "alternateAddressCityname":"Ombudsman",
:  null,       "objectStatus"alternateAddressState:"ACTIVE"
: null,     }
 "alternateAddressZipCode" : null],
   "serviceReasons":[  
"alternateAddressCountry" : null,    {  
"photoUrl" : null,       "schoolId" : null,"id":"0a640a2a-409d-1271-8140-d0b3878000f6",
         "enabled" : false,"name":"Scholarship Recipient",
         "objectStatus":"studentIntakeCompleteDateACTIVE"
: null,      },
      { "studentType" :
         {"id" : "ce0d041d85709794-d3ac1326-42a111e2-90858bab-7f744240e07e406c8f22c3ce",

         "name" : "EarlyAcademically AlertUnprepared",
          "objectStatus":"ACTIVE"
      },},
      { "coach" :
         {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",
         "name":"At-Risk Student",
         "firstNameobjectStatus" : "Amy",ACTIVE"
      },
      {  
         "lastNameid" : "Advisor"205df6c0-fea0-11e1-9678-406c8f22c3ce",
          "primaryEmailAddressname" : "amy.advisor@university.edu"Career Coaching",
          "workPhone" : "(123) 456-7890","objectStatus":"ACTIVE"
      }
   ],
   "officeLocationconfidentialityLevels" :null,
"123 Benton Hall Room A""permissions":null,
   "currentProgramStatusName":"Active",
      "departmentNameprogramStatusChangeReasonName" :null,
"Engineering & Applied Science"
		  "photoUrl":"http://192.168.0.151:8080/images/0000000.png"}"registeredForCurrentTerm":false,
   "activeAlertsCount":2,
   "closedAlertsCount":1,
   "strengthsresidencyCounty" : "Good test takerDemoCounty",
   "f1Status":"Y",
   "abilityToBenefitgender" : true"M",
      "anticipatedStartTermmaritalStatus" : "FallSeparated",
   "ethnicity":null,
   "anticipatedStartYearrace":null,
  : "2012actionPlanTaskOpenCount":1,
   "actionPlanTaskClosedCount":4,
   "actualStartTermlastActionPlanCompletedDate":"Fall"1440076479537,
   "confidentialityDisclosureAgreementSignedDate":1440076476617,
   "actualStartYearhomeCampus":2012,{  
      "studentIntakeRequestDateid" : 1331269200000:"901e104b-4dc7-43f5-a38e-581015e204e1",
      "specialServiceGroupsname" : 
  "North Campus",
      [{"idobjectStatus" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
		"ACTIVE"
   },
   "nameformattedCDACompleteDate" : "Basketball Team"2015-08-20",	
		   "objectStatusformattedStudentIntakeCompleteDate" :null
"ACTIVE"}}

Returns

Person

Code Block
{  
   "id":"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
   ],
  "createdDate":1356998400000,
   "referralSourcescreatedBy" : 
{  
      [{"id" : "a8c83fd422fc02f1-ee33d8b6-46ee496c-8d898e2d-9b2956696f3765f6973f888e",
		      "firstName":"nameDemo",
: "Counseling Services". 		   "objectStatuslastName" : "ACTIVECoach13"},
      "fullName":"Demo Coach13"
   ]},
   "modifiedDate":1444021202117,
   "serviceReasonsmodifiedBy" : {  
       [{"id" : "d95ea02958ba5ee3-90c1734e-4be04ae9-b547b9c5-8054fc6914b7943774b4de41"},
  		    "namefirstName" : "Developmental EducationSystem",
		      "objectStatuslastName" : "ACTIVEAdministrator"},
      "fullName":"System Administrator"
   ]},
   "objectStatus":"ACTIVE",
   "confidentialityLevelsfirstName" : null"James",
    "middleName":"Jacob",
   "permissionslastName" : null"Anderson",
      "currentProgramStatusNamebirthDate" : "Active1986-10-24",
  
   "registeredForCurrentTermprimaryEmailAddress" : true
:"demo@trainingssp.com",
     "activeAlertsCountsecondaryEmailAddress":1"",
      "closedAlertsCountusername":2"janderson218",
 
    "paymentStatushomePhone":"Y Y Y(555) 555-5412",
 
    "registeredTermsworkPhone":"2013FA",
2013SP 2013SU"
	  "residencyCountycellPhone":"Butler",
	   "f1StatusalternatePhone":"Y212-555-1212",
 	  "gendernonLocalAddress":"M"false,
	   "maritalStatusaddressLine1":"Single321 W. Demo St.",
 	  "ethnicityaddressLine2":null,
	"Apt. 214",
   "actionPlanTaskOpenCountcity":4"Phoenix",
	   "actionPlanTaskClosedCountstate":15"AZ",
	   "lastActionPlanCompletedDatezipCode":1367297284590
 "55555     "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" : "Sally",
  ,
   "alternateAddressInUse":false,
   "middleNamealternateAddressLine1" : null"",
      "lastNamealternateAddressLine2" : "Student",
      "birthDatealternateAddressCity" : "1983-08-20",
      "primaryEmailAddress"alternateAddressState":" : "sally.student@university.edu",
      "secondaryEmailAddressalternateAddressZipCode" :" null,       "username" : "sally.student",
  
   "homePhonealternateAddressCountry" : "123-456-7890",
      "workPhonephotoUrl" : null,
  
   "cellPhoneschoolId" : null,
  "janderson218",
   "nonLocalAddressenabled" : nulltrue,

     "addressLine1studentIntakeCompleteDate" : "444 West Third Street",
  :null,
   "addressLine2studentType":{ : null,
      "cityid" : "Dayton"0a640a2a-409d-1271-8140-d0af4a4200ef",
      "statename" : "OH"Non-Degree Seeking",
      "zipCodeobjectStatus" : "45402ACTIVE",
   },
   "alternateAddressLineInUsecoach":{ : null,
      "alternateAddressLine1id" : null:"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "alternateAddressLine2firstName" : null"Demo",
      "alternateAddressCitylastName" : null"Coach13",
      "alternateAddressStateprimaryEmailAddress" : null:"demo@trainingssp.com",
      "alternateAddressZipCodeworkPhone" : null"(777) 777-7777",
      "alternateAddressCountryofficeLocation" : null,
      "photoUrldepartmentName" : null,
      "schoolIdhomeCampusName" :"West nullCampus",
      "enabledphotoUrl" :null
false,   },
   "studentIntakeCompleteDateabilityToBenefit" :true,
null,   "anticipatedStartTerm":"",
   "studentTypeanticipatedStartYear" :2011,
   "actualStartTerm":"FA2011",
   "actualStartYear":2011,
 {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"studentIntakeRequestDate":1440076505197,
   "specialServiceGroups":[  
    "name" : "Early{ Alert" 
         "objectStatusid":"ACTIVE"},},856a3600-1326-11e2-9b79-406c8f22c3ce",
         "name"coach:"Student :Athlete",
         {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280","ACTIVE"
      },
     "firstName" :{ "Amy", 
         "lastNameid" : "Advisor"0a640a2a-409d-1271-8140-d0c138a100fd",
          "name"primaryEmailAddress:"DEI :Focus Group"amy.advisor@university.edu",
          "workPhoneobjectStatus" : "(123) 456-7890","ACTIVE"
      }
   "officeLocation"],
: "123 Benton Hall"referralSources":[ Room A",
      {  
 "departmentName" : "Engineering & Applied Science" 		  "photoUrlid":"http://192.168.0.151:8080/images/0000000.png"},859ff107-1326-11e2-8698-406c8f22c3ce",
         "strengthsname" :"Student Conduct"Good,
 test taker",       "objectStatus":"abilityToBenefitACTIVE"
     : true},
      { "anticipatedStartTerm" 
 : "Fall",       "anticipatedStartYearid" : "2012","858b0cab-1326-11e2-818e-406c8f22c3ce",
         "actualStartTermname":"FallHS Guidance Counselor",
         "actualStartYearobjectStatus":2012,"ACTIVE"
      "studentIntakeRequestDate" : 1331269200000},
      "specialServiceGroups"{ : 
         [{"id" : "437f6f2bf6201a04-7b1ebb31-47b44ca5-8603b606-9e1208605c0d",
		609f3ad09f87",
         "name":"Faculty :/ "BasketballStaff TeamReferral",	
		
         "objectStatus" : "ACTIVE"}
         ]},
      "referralSources"{ : 
         [{"id" : "a8c83fd4ccadd634-ee33bd7a-46ee11e1-8d898d28-9b2956696f373368721922dc",
		
  "name" : "Counseling Services". 		   "objectStatusname" : "ACTIVEOmbudsman"},
         ],
      "serviceReasons" : 
   "objectStatus":"ACTIVE"
     [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		
  "name" : "Developmental Education"],
		   "objectStatusserviceReasons":[ : "ACTIVE"} 
      {  
  ],       "confidentialityLevelsid" : null,:"0a640a2a-409d-1271-8140-d0b3878000f6",
         "permissionsname" :"Scholarship nullRecipient",
         "currentProgramStatusNameobjectStatus" : "Active"ACTIVE"
      },
      "registeredForCurrentTerm" : true{  
         "activeAlertsCountid":1,"85709794-1326-11e2-8bab-406c8f22c3ce",
         "closedAlertsCountname":2"Academically Unprepared",
         "paymentStatusobjectStatus":"ACTIVE"Y
   Y Y",  },
    "registeredTerms":"2013FA 2013SP 2013SU"{ 	 
"residencyCounty":"Butler", 	  "f1Status":"Y", 	  "gender":"M", 	  "maritalStatusid":"Singlef6201a04-bb31-4ca5-b606-609f3ad09f87",
 	  "ethnicity":null, 	  "actionPlanTaskOpenCount":4, 	  "actionPlanTaskClosedCountname":15,
	  "lastActionPlanCompletedDate":1367297284590"At-Risk Student",
      "formattedStudentIntakeCompleteDate":null}   ] }

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"objectStatus":"ACTIVE"
     "createdDate" : 1331269200000 },
      "createdBy"{  :
         {"id" : "91f46e39205df6c0-cea8fea0-422b11e1-b2159678-00f6bcf5d280406c8f22c3ce",
          "firstNamename" :"Career "JohnCoaching",

         "lastNameobjectStatus" : "DoeACTIVE"},
      }
 "modifiedDate" : 1331269200000],
 
    "modifiedByconfidentialityLevels" :null,
   "permissions":null,
     {"idcurrentProgramStatusName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Active",
   "programStatusChangeReasonName":null,
   "registeredForCurrentTerm":false,
   "firstNameactiveAlertsCount":2,
:   "JohnclosedAlertsCount":1,
      "residencyCounty":"DemoCounty",
   "lastNamef1Status" : "DoeY"}, 
      "objectStatusgender" : "ACTIVEM",
  
   "firstNamemaritalStatus" : "SallySeparated",
   "ethnicity":null,
   "middleNamerace" : null,
      "lastNameactionPlanTaskOpenCount" : "Student",
  1,
   "birthDateactionPlanTaskClosedCount" : "1983-08-20":4,
      "primaryEmailAddresslastActionPlanCompletedDate" : "sally.student@university.edu",
 :1440076479537,
    "secondaryEmailAddressconfidentialityDisclosureAgreementSignedDate" : null1440076476617,
  
   "usernamehomeCampus":{ : "sally.student",
      "homePhoneid" : "123-456-7890901e104b-4dc7-43f5-a38e-581015e204e1",
      "workPhonename" :"North nullCampus",
      "objectStatus"cellPhone:"ACTIVE"
  : null},
   "formattedCDACompleteDate":"2015-08-20",
   "nonLocalAddressformattedStudentIntakeCompleteDate" : 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
{  
   "addressLine1id" : "444 West Third Street",
 "d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
    "addressLine2createdDate" : null1356998400000,
      "citycreatedBy":{ : "Dayton",
      "stateid" : "OH"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "zipCodefirstName" : "45402Demo",
      "alternateAddressLineInUselastName" : null"Coach13",
      "fullName"alternateAddressLine1:"Demo :Coach13"
null,   },
   "alternateAddressLine2modifiedDate" : null1444021202117,
      "alternateAddressCitymodifiedBy":{ : null,
      "alternateAddressStateid" : null:"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "alternateAddressZipCodefirstName" : null"System",
      "alternateAddressCountrylastName" : null"Administrator",
      "fullName"photoUrl:"System :Administrator"
null,   },
   "schoolIdobjectStatus" :"ACTIVE",
null,   "firstName":"James",
   "enabledmiddleName" : false"Jacob",
   "lastName":"Anderson",
   "studentIntakeCompleteDatebirthDate" : null:"1986-10-24",
   "primaryEmailAddress":"demo@trainingssp.com",
   "studentTypesecondaryEmailAddress" :"",
     "username":"janderson218",
   {"idhomePhone" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"(555) 555-5412",
      "workPhone":"",
   "namecellPhone" : "Early Alert",
   "alternatePhone":"212-555-1212",
   "nonLocalAddress":false,
   "objectStatusaddressLine1":"ACTIVE"},},
  321 W. Demo St.",
   "coachaddressLine2" :"Apt. 214",
    "city":"Phoenix",
   {"idstate" : "91f46e39-cea8-422b-b215-00f6bcf5d280"AZ",
   "zipCode":"55555     ",
 "firstName" : "AmyalternateAddressInUse":false,
   "alternateAddressLine1":"",
      "lastNamealternateAddressLine2" : "Advisor",
    
     "primaryEmailAddressalternateAddressCity" : "amy.advisor@university.edu",
   "alternateAddressState":"  ",
    "alternateAddressZipCode"workPhone:" : "(123) 456-7890",       ",
   "officeLocationalternateAddressCountry" : ""123,
Benton Hall Room A"photoUrl":null,
   "schoolId":"janderson218",
      "departmentNameenabled" :true,
"Engineering & Applied Science"studentIntakeCompleteDate":null,
		   "photoUrl":"http://192.168.0.151:8080/images/0000000.png"},studentType":{  
      "strengthsid" : "Good test taker"0a640a2a-409d-1271-8140-d0af4a4200ef",
      "abilityToBenefitname" : true"Non-Degree Seeking",
      "anticipatedStartTermobjectStatus" : "FallACTIVE",
   },
   "anticipatedStartYearcoach":{ : "2012",
      "actualStartTermid":"Fall22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "actualStartYearfirstName":2012"Demo",
      "studentIntakeRequestDatelastName" : 1331269200000"Coach13",
      "specialServiceGroupsprimaryEmailAddress" : :"demo@trainingssp.com",
         [{"idworkPhone" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
		"(777) 777-7777",
    "name" : "Basketball TeamofficeLocation":null,	
		
  "objectStatus" : "ACTIVE"}  "departmentName":null,
       ]"homeCampusName":"West Campus",
      "referralSourcesphotoUrl":null
:   },
   "abilityToBenefit":true,
   [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
		"anticipatedStartTerm":"",
   "anticipatedStartYear":2011,
   "nameactualStartTerm" : "Counseling ServicesFA2011".,
		   "objectStatusactualStartYear" : "ACTIVE"}2011,
   "studentIntakeRequestDate":1440076505197,
   "specialServiceGroups":[  ],
      "serviceReasons"{ : 
         [{"id" : "d95ea029856a3600-90c11326-4be011e2-b5479b79-8054fc6914b7406c8f22c3ce"},
		
         "name" : "DevelopmentalStudent EducationAthlete",
		
         "objectStatus" : "ACTIVE"}
      },
  ],    {  
"confidentialityLevels" : null,         "permissions" : null,"id":"0a640a2a-409d-1271-8140-d0c138a100fd",
         "name"currentProgramStatusName:"DEI :Focus "ActiveGroup",
 
    "registeredForCurrentTerm" : true       "activeAlertsCountobjectStatus":1,"ACTIVE"
      }
"closedAlertsCount":2,   ],
   "paymentStatusreferralSources":"Y[  Y
Y",      { "registeredTerms":"2013FA 2013SP
2013SU" 	  "residencyCounty":"Butler", 	  "f1Status":"Y", 	  "genderid":"M859ff107-1326-11e2-8698-406c8f22c3ce",
 	  "maritalStatus":"Single", 	  "ethnicity":null, 	  "actionPlanTaskOpenCountname":4,
	  "actionPlanTaskClosedCount":15"Student Conduct",
	  "lastActionPlanCompletedDate":1367297284590       "formattedStudentIntakeCompleteDate":null} 
 ]
}

 

Save a Person

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

Security

PERSON_WRITE

Note

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

Sample Post

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41objectStatus":"ACTIVE"
      },
      {  
         "id":"858b0cab-1326-11e2-818e-406c8f22c3ce",
         "name"createdDate:"HS :Guidance 1331269200000Counselor",
         "objectStatus"createdBy" ::"ACTIVE"
      },
      {  
         "id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",
          "name"firstName:"Faculty :/ Staff Referral"John",
          "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : 1331269200000,},
      {  "modifiedBy"
:          {"id" : "91f46e39ccadd634-cea8bd7a-422b11e1-b2158d28-00f6bcf5d2803368721922dc",

         "firstNamename" : "JohnOmbudsman",

         "lastNameobjectStatus" : "DoeACTIVE"},
      }
 "objectStatus" : "ACTIVE"],
   "serviceReasons":[  
"firstName" : "Sally",    {  
"middleName" : null,       "lastNameid" : "Student"0a640a2a-409d-1271-8140-d0b3878000f6",
         "birthDatename" :"Scholarship Recipient"1983-08-20",
         "primaryEmailAddressobjectStatus" : "sally.student@university.eduACTIVE",
      "secondaryEmailAddress" : null,},
      {  
"username" : "sally.student",       "homePhoneid" : "123-456-7890",85709794-1326-11e2-8bab-406c8f22c3ce",
         "workPhonename" :"Academically nullUnprepared",
         "cellPhoneobjectStatus" : null,:"ACTIVE"
      "nonLocalAddress" : null,},
      { "addressLine1" :
"444 West Third Street",       "addressLine2" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "cityname" : "Dayton"At-Risk Student",
         "stateobjectStatus" : "OHACTIVE",
      },
"zipCode" : "45402",    {  
"alternateAddressLineInUse" : null,       "alternateAddressLine1" : null,"id":"205df6c0-fea0-11e1-9678-406c8f22c3ce",
         "alternateAddressLine2name" :"Career nullCoaching",
      "alternateAddressCity   "objectStatus":"ACTIVE"
: null,     }
 "alternateAddressState" : null],
 
    "alternateAddressZipCodeconfidentialityLevels" : null,
      "alternateAddressCountrypermissions" : null,
  
   "photoUrlcurrentProgramStatusName" : null,
  "Active",
   "schoolIdprogramStatusChangeReasonName" : null,
      "enabledregisteredForCurrentTerm" : false,
   "activeAlertsCount":2,
   "studentIntakeCompleteDateclosedAlertsCount" :1,
null,   "residencyCounty":"DemoCounty",
   "studentTypef1Status" :"Y",
     "gender":"M",
   {"idmaritalStatus" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"Separated",
   "ethnicity":null,
   "race":null,
   "nameactionPlanTaskOpenCount" :1,
"Early Alert"  "actionPlanTaskClosedCount":4,
    "lastActionPlanCompletedDate":1440076479537,
   "objectStatusconfidentialityDisclosureAgreementSignedDate":"ACTIVE"},},
  1440076476617,
   "coachhomeCampus" :
{  
      {"id" : "91f46e39901e104b-cea84dc7-422b43f5-b215a38e-00f6bcf5d280581015e204e1",
   
      "firstNamename" :"North "AmyCampus",
   
      "lastNameobjectStatus" : "AdvisorACTIVE",
   },
      "primaryEmailAddressformattedCDACompleteDate" : "amy.advisor@university.edu",
    "2015-08-20",
     "workPhoneformattedStudentIntakeCompleteDate" : "(123) 456-7890",
   null
}

Returns

Person

Code Block
{  
    "officeLocationid" : "123 Benton Hall Room A"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
   "createdDate":1356998400000,
      "departmentNamecreatedBy":{ : 
"Engineering & Applied Science" 		  "photoUrlid":"http://192.168.0.151:8080/images/0000000.png"}22fc02f1-d8b6-496c-8e2d-65f6973f888e",
       "strengthsfirstName" : "Good test takerDemo",
      "abilityToBenefitlastName" : true"Coach13",
      "anticipatedStartTermfullName" :"Demo "FallCoach13",
   },
   "anticipatedStartYearmodifiedDate":1444021202117,
  : "2012",modifiedBy":{  
      "actualStartTermid":"Fall58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "firstName":"actualStartYearSystem":2012,
      "studentIntakeRequestDatelastName" : 1331269200000"Administrator",
      "specialServiceGroupsfullName" :"System Administrator"
     },
   [{"idobjectStatus" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"ACTIVE",
		   "namefirstName" : "Basketball TeamJames",	
		   "objectStatusmiddleName" : "ACTIVEJacob"},
   "lastName":"Anderson",
     ]"birthDate":"1986-10-24",
      "referralSourcesprimaryEmailAddress" :"demo@trainingssp.com",
          [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"secondaryEmailAddress":"",
		   "nameusername" : "Counseling Servicesjanderson218".,
		   "objectStatushomePhone" : "ACTIVE"}"(555) 555-5412",
   "workPhone":"",
   "cellPhone":"",
 ],   "alternatePhone":"212-555-1212",
   "serviceReasonsnonLocalAddress" :false,
   "addressLine1":"321 W. Demo St.",
   [{"idaddressLine2" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		"Apt. 214",
   "namecity" : "Developmental EducationPhoenix",
		   "objectStatusstate" : "ACTIVEAZ"},
   "zipCode":"55555      ]",

     "confidentialityLevelsalternateAddressInUse" : nullfalse,
   "alternateAddressLine1":"",
    "permissionsalternateAddressLine2" : null"",
 
    "currentProgramStatusNamealternateAddressCity" : "Active",
      "registeredForCurrentTermalternateAddressState" :" true   ",
   "activeAlertsCountalternateAddressZipCode":1,"       "closedAlertsCount":2,   ",
   "paymentStatusalternateAddressCountry":"Y Y Y",
   "photoUrl":null,
   "registeredTermsschoolId":"2013FAjanderson218",
  2013SP 2013SU"
	"enabled":true,
   "residencyCountystudentIntakeCompleteDate":"Butler"null,
 	  "f1StatusstudentType":"Y",
	{  
      "genderid":"M0a640a2a-409d-1271-8140-d0af4a4200ef",
  	    "maritalStatusname":"SingleNon-Degree Seeking",
 	  "ethnicity":null, 	  "actionPlanTaskOpenCountobjectStatus":4,
	  "actionPlanTaskClosedCount":15,
	"ACTIVE"
   },
   "lastActionPlanCompletedDatecoach":1367297284590{  
    "formattedStudentIntakeCompleteDate":null}   ]
}

Returns

Person

Code Block
{"id" : "58ba5ee322fc02f1-734ed8b6-4ae9496c-b9c58e2d-943774b4de4165f6973f888e",
      "createdDatefirstName" : 1331269200000"Demo",
      "lastName"createdBy:"Coach13",
 :      "primaryEmailAddress":"demo@trainingssp.com",
      {"idworkPhone" : "91f46e39-cea8-422b-b215-00f6bcf5d280","(777) 777-7777",
      "officeLocation":null,
    "firstName" : "JohndepartmentName":null,
 
        "lastNamehomeCampusName" :"West Campus"Doe"}, 
      "modifiedDatephotoUrl" :null
1331269200000,   },
   "modifiedByabilityToBenefit" :true,
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280"anticipatedStartTerm":"",
      "anticipatedStartYear":2011,
   "firstNameactualStartTerm" : "JohnFA2011",
      "actualStartYear":2011,
   "lastNamestudentIntakeRequestDate" : "Doe"}1440076505197,
   "specialServiceGroups":[  
 "objectStatus" : "ACTIVE",   {  
 "firstName" : "Sally",       "middleName" : null,"id":"856a3600-1326-11e2-9b79-406c8f22c3ce",
         "lastNamename" : "Student Athlete",
         "birthDateobjectStatus" : "1983-08-20ACTIVE",
      "primaryEmailAddress" : "sally.student@university.edu",},
      {  
"secondaryEmailAddress" : null,       "usernameid" : "sally.student"0a640a2a-409d-1271-8140-d0c138a100fd",
      "homePhone" : "123-456-7890",   "name":"DEI Focus Group",
         "workPhoneobjectStatus" :"ACTIVE"
null,      }
"cellPhone"  : null],
  
   "nonLocalAddressreferralSources":[ : null,
      "addressLine1"{ : "444
West Third Street",       "addressLine2" : null,id":"859ff107-1326-11e2-8698-406c8f22c3ce",
         "cityname" :"Student Conduct"Dayton",
         "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" : false,:"ACTIVE"
      "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 "AdvisorRecipient",
          "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" : "BasketballCareer TeamCoaching",	
		
         "objectStatus" : "ACTIVE"}
      }
   ],
  
   "referralSourcesconfidentialityLevels" : 
     :null,
   [{"idpermissions" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37":null,
		   "namecurrentProgramStatusName" : "Counseling ServicesActive".,
		   "objectStatusprogramStatusChangeReasonName" : "ACTIVE"},
         ],: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
      "formattedStudentIntakeCompleteDate":null} 
 ]
}"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}

...