Page Comparison

...

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":"SingleACTIVE",
 	  "ethnicity":null, 	  "actionPlanTaskOpenCount":4,
	  "actionPlanTaskClosedCount":15,
	}
   ],
   "lastActionPlanCompletedDateserviceReasons":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",
         "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",
         "lastNameobjectStatus" : "Coach"ACTIVE"
      },
      {  
         "id" : "63d62297ccadd634-bf08bd7a-496f11e1-acf38d28-0c129d437c2b3368721922dc",
         "firstNamename" : "ChristinaOmbudsman",
         "lastNameobjectStatus" : "CoachACTIVE"},
      ...}
    ]
}

Get a Person

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

Security

PERSON_READ

Returns

Person

Code Block

 ,
   [{"idserviceReasons" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",[  
     "createdDate" : 1331269200000,
      "createdBy" :{  
          {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0b3878000f6",
          "firstNamename" :"Scholarship "JohnRecipient",

         "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : 1331269200000,},
      { "modifiedBy" :
         {"id" : "91f46e3985709794-cea81326-422b11e2-b2158bab-00f6bcf5d280406c8f22c3ce",
          "firstNamename" :"Academically "JohnUnprepared",

         "lastNameobjectStatus" : "DoeACTIVE"},
      },
"objectStatus" : "ACTIVE",    {  
"firstName" : "Sally",       "middleName" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "lastNamename" :"At-Risk "Student",
   
  "birthDate" : null,       "primaryEmailAddressobjectStatus" : "sally.student@university.edu",ACTIVE"
      },
"secondaryEmailAddress" : null,    {  
"username" : "sally.student",       "homePhoneid" : "123-456-7890",205df6c0-fea0-11e1-9678-406c8f22c3ce",
         "workPhonename" :"Career nullCoaching",
         "objectStatus"cellPhone:"ACTIVE"
: null,      }
   ],
   "nonLocalAddressconfidentialityLevels" : null,
   "permissions":null,
   "addressLine1currentProgramStatusName" :"Active",
"444 West Third Street"programStatusChangeReasonName":null,
   "registeredForCurrentTerm":false,
   "addressLine2activeAlertsCount" : null2,

     "cityclosedAlertsCount" : "Dayton"1,

     "stateresidencyCounty" : "OHDemoCounty",
  
   "zipCodef1Status" : "45402Y",

     "alternateAddressLineInUsegender" : null"M",

     "alternateAddressLine1maritalStatus" : null"Separated",
      "alternateAddressLine2ethnicity" : null,

     "alternateAddressCityrace" : null,
      "alternateAddressStateactionPlanTaskOpenCount" : null1,
  
   "alternateAddressZipCodeactionPlanTaskClosedCount" : null4,

     "alternateAddressCountrylastActionPlanCompletedDate" : null1440076479537,
  
   "photoUrlconfidentialityDisclosureAgreementSignedDate" : null1440076476617,
  
   "schoolIdhomeCampus":{ : null,
      "enabledid" : false:"901e104b-4dc7-43f5-a38e-581015e204e1",
      "studentIntakeCompleteDatename" :"North nullCampus",
      "studentTypeobjectStatus" :"ACTIVE"
     },
   {"idformattedCDACompleteDate" : "ce0d041d2015-d3ac-42a1-9085-7f744240e07e08-20",
          "name" : "Early Alert"
          "objectStatus":"ACTIVE"},},
  "formattedStudentIntakeCompleteDate":null
}

Create a Person

POST /ssp/api/1/person

Security

PERSON_WRITE

Note

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

Sample Post

Code Block

 { "firstName":"James",
   "middleName":"Jacob",
   "coachlastName" :
 :"Anderson",
       {"idbirthDate" : "91f46e391986-cea8-422b-b215-00f6bcf5d280",
     10-24",
    "firstNameprimaryEmailAddress" : "Amydemo@trainingssp.com",
      
   "lastNamesecondaryEmailAddress" : "Advisor",
          "primaryEmailAddress" : "amy.advisor@university.edu"username":"janderson218",
      "homePhone":"(555) 555-5412",
   "workPhone" : "(123) 456-7890",
      "cellPhone":"",
   "officeLocationalternatePhone" : "123 Benton Hall Room A":"212-555-1212",
   "nonLocalAddress":false,
   "addressLine1":"321 W. Demo St.",
   "departmentNameaddressLine2" :"Apt. 214"Engineering,
& Applied Science" 		  "photoUrlcity":"http://192.168.0.151:8080/images/0000000.png"}Phoenix",
   "state":"AZ",
   "strengthszipCode" : "Good55555 test taker",   ",
   "abilityToBenefitalternateAddressInUse" : truefalse,

     "anticipatedStartTermalternateAddressLine1" : "Fall",
      "anticipatedStartYearalternateAddressLine2" : "2012",
  
   "actualStartTermalternateAddressCity":"Fall",
  
   "actualStartYearalternateAddressState":2012,"   ",
   "studentIntakeRequestDatealternateAddressZipCode" :" 1331269200000,       "specialServiceGroups" : 
  ",
      [{"idalternateAddressCountry" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
		   "namephotoUrl" : "Basketball Team",	
		:null,
   "objectStatusschoolId" : "ACTIVEjanderson218"},
   "enabled":true,
     ],
 "studentIntakeCompleteDate":null,
    "referralSourcesstudentType" : 
{  
      [{"id" : "a8c83fd40a640a2a-ee33409d-46ee1271-8d898140-9b2956696f37d0af4a4200ef",
 		     "name" :"Non-Degree Seeking"Counseling Services".
		,
      "objectStatus" : "ACTIVE"},
   },
   "coach":{  ],
      "serviceReasonsid" ::"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
          [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		"firstName":"Demo",
      "namelastName" : "Developmental EducationCoach13",
   		   "objectStatusprimaryEmailAddress" : "ACTIVE"}
demo@trainingssp.com",
        ]"workPhone":"(777) 777-7777",
      "confidentialityLevelsofficeLocation" : null,
        "permissionsdepartmentName" : null,
      "currentProgramStatusNamehomeCampusName" :"West "ActiveCampus",
      "registeredForCurrentTermphotoUrl" :null
true   },
   "activeAlertsCountabilityToBenefit":1true,
   "anticipatedStartTerm":"",
   "closedAlertsCountanticipatedStartYear":22011,
      "paymentStatusactualStartTerm":"Y Y YFA2011",
      "registeredTermsactualStartYear":"2013FA2011,
2013SP 2013SU"
	  "residencyCountystudentIntakeRequestDate":"Butler"1440076505197,
	   "f1Status":"Y",
	specialServiceGroups":[  
      {  
         "genderid":"M856a3600-1326-11e2-9b79-406c8f22c3ce",
	   "maritalStatus":"Single", 	  "ethnicity":null, 	  "actionPlanTaskOpenCountname":4,
	  "actionPlanTaskClosedCount":15"Student Athlete",
	  "lastActionPlanCompletedDate":1367297284590       "formattedStudentIntakeCompleteDateobjectStatus":null}"ACTIVE"
      ] }

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" : "58ba5ee30a640a2a-734e409d-4ae91271-b9c58140-943774b4de41d0c138a100fd",
         "name"createdDate:"DEI :Focus 1331269200000Group",
      "createdBy" :   "objectStatus":"ACTIVE"
      }
   ],
   "referralSources":[  
       {{  
         "id" : "91f46e39859ff107-cea81326-422b11e2-b2158698-00f6bcf5d280406c8f22c3ce",
          "firstNamename" :"Student "JohnConduct",

         "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : 1331269200000,},
      { "modifiedBy" :
         {"id" : "91f46e39858b0cab-cea81326-422b11e2-b215818e-00f6bcf5d280406c8f22c3ce",
          "name"firstName:"HS :Guidance "JohnCounselor",

         "lastNameobjectStatus" : "DoeACTIVE"},
      },
"objectStatus" : "ACTIVE",    {  
"firstName" : "Sally",       "middleName" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "name"lastName:"Faculty : "Student/ Staff Referral",
         "birthDateobjectStatus" :"ACTIVE"
null,      },
"primaryEmailAddress" : "sally.student@university.edu",    {  
"secondaryEmailAddress" : null,       "usernameid" : "sally.student","ccadd634-bd7a-11e1-8d28-3368721922dc",
         "homePhonename" : "123-456-7890Ombudsman",
      "workPhone   "objectStatus":"ACTIVE"
: null,     }
 "cellPhone" : null],
  
   "nonLocalAddressserviceReasons":[ : null,
      "addressLine1"{ : "444
West Third Street",       "addressLine2" : null,"id":"0a640a2a-409d-1271-8140-d0b3878000f6",
         "cityname" :"Scholarship "DaytonRecipient",
         "stateobjectStatus" : "OHACTIVE",
      },
"zipCode" : "45402",    {  
"alternateAddressLineInUse" : null,       "alternateAddressLine1" : null,"id":"85709794-1326-11e2-8bab-406c8f22c3ce",
         "alternateAddressLine2name" :"Academically nullUnprepared",
         "alternateAddressCityobjectStatus" :"ACTIVE"
null,      },
"alternateAddressState" : null,    {  
"alternateAddressZipCode" : null,       "alternateAddressCountryid" : null,
      "photoUrl" : null,:"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"},},
      "coach"}
:   ],
      {"idconfidentialityLevels" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      :null,
   "firstNamepermissions" : "Amy",
      null,
   "lastNamecurrentProgramStatusName" : "AdvisorActive",
   "programStatusChangeReasonName":null,
   "registeredForCurrentTerm":false,
   "primaryEmailAddressactiveAlertsCount":2,
  : "amy.advisor@university.edu"closedAlertsCount":1,
    "residencyCounty":"DemoCounty",
     "workPhonef1Status" : "(123) 456-7890"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 "FallCampus",
      "anticipatedStartYearobjectStatus" : "2012ACTIVE",
   },
   "actualStartTermformattedCDACompleteDate":"Fall2015-08-20",
   "formattedStudentIntakeCompleteDate":null
}

Returns

Person

Code Block

{  
   "actualStartYearid":2012,
  "d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
   "studentIntakeRequestDatecreatedDate" : 13312692000001356998400000,

     "specialServiceGroupscreatedBy" : {  
       [{"id" : "437f6f2b22fc02f1-7b1ed8b6-47b4496c-86038e2d-9e1208605c0d65f6973f888e",
   		   "namefirstName" : "Basketball TeamDemo",	
   		   "objectStatuslastName" : "ACTIVECoach13"},
      "fullName":"Demo Coach13"
  ] },
   "modifiedDate":1444021202117,
   "referralSourcesmodifiedBy" :{  
        [{"id" : "a8c83fd458ba5ee3-ee33734e-46ee4ae9-8d89b9c5-9b2956696f37943774b4de41",
   		   "namefirstName" :"System",
"Counseling Services".  		   "objectStatuslastName" : "ACTIVEAdministrator"},
      "fullName":"System Administrator"
 ]  },
   "objectStatus":"ACTIVE",
   "serviceReasonsfirstName" :"James",
   "middleName":"Jacob",
   "lastName":"Anderson",
   [{"idbirthDate" : "d95ea0291986-90c1-4be0-b547-8054fc6914b7"}10-24",
		   "nameprimaryEmailAddress" : "Developmental Education"demo@trainingssp.com",
		   "objectStatussecondaryEmailAddress" : "ACTIVE"},
   "username":"janderson218",
     ]"homePhone":"(555) 555-5412",
   "workPhone":"",
   "confidentialityLevelscellPhone" : null"",
    "alternatePhone":"212-555-1212",
   "permissionsnonLocalAddress" : nullfalse,

     "currentProgramStatusNameaddressLine1" : "Active",321 W. Demo St.",
   "registeredForCurrentTermaddressLine2" : true
 "Apt. 214",
    "activeAlertsCountcity":1"Phoenix",
      "closedAlertsCountstate":2"AZ",
 
    "paymentStatuszipCode":"Y55555 Y Y",   ",
   "registeredTermsalternateAddressInUse":"2013FA 2013SP 2013SU"
	false,
   "residencyCountyalternateAddressLine1":"Butler",
 	  "f1StatusalternateAddressLine2":"Y",
	   "genderalternateAddressCity":"M",
 	  "maritalStatusalternateAddressState":"Single  ",
 	  "ethnicityalternateAddressZipCode":null,
	  "actionPlanTaskOpenCount":4,
	  "actionPlanTaskClosedCount":15,
	  "lastActionPlanCompletedDate":1367297284590"          ",
   "alternateAddressCountry":"",
      "formattedStudentIntakeCompleteDatephotoUrl":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 "schoolId":"janderson218",
   "enabled":true,
   "middleNamestudentIntakeCompleteDate" : null,
      "lastNamestudentType":{ : "Student",
      "birthDateid" : null:"0a640a2a-409d-1271-8140-d0af4a4200ef",
      "primaryEmailAddressname" : "sally.student@university.edu"Non-Degree Seeking",
      "secondaryEmailAddressobjectStatus" :"ACTIVE"
null,   },
   "usernamecoach":{ : "sally.student",
      "homePhoneid" : "123-456-789022fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "workPhonefirstName" : null"Demo",
      "cellPhonelastName" : null"Coach13",
      "nonLocalAddressprimaryEmailAddress" : null:"demo@trainingssp.com",
      "addressLine1workPhone" : "444 West Third Street(777) 777-7777",
      "addressLine2officeLocation" : null,
      "citydepartmentName" : "Dayton"null,
      "statehomeCampusName" :"West Campus"OH",
      "zipCodephotoUrl" :null
"45402",   },
   "alternateAddressLineInUseabilityToBenefit" : nulltrue,
   "anticipatedStartTerm":"",
   "alternateAddressLine1anticipatedStartYear" : null2011,

     "alternateAddressLine2actualStartTerm" : null,
  "FA2011",
   "alternateAddressCityactualStartYear" : null2011,
 
    "alternateAddressStatestudentIntakeRequestDate" : null1440076505197,
   "specialServiceGroups":[  
"alternateAddressZipCode" : null,    {  
"alternateAddressCountry" : null,       "photoUrl" : null,"id":"856a3600-1326-11e2-9b79-406c8f22c3ce",
         "schoolIdname" :"Student nullAthlete",
         "enabledobjectStatus" :"ACTIVE"
false,      },
"studentIntakeCompleteDate" : null,    {   "studentType" :
         {"id" : "ce0d041d0a640a2a-d3ac409d-42a11271-90858140-7f744240e07ed0c138a100fd",
          "name" :"DEI "EarlyFocus AlertGroup",
          "objectStatus":"ACTIVE"},},
      "coach"}
:     ],
    {"idreferralSources" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 :[  
      "firstName" :{ "Amy", 
         "lastNameid" : "Advisor"859ff107-1326-11e2-8698-406c8f22c3ce",
          "primaryEmailAddressname" : "amy.advisor@university.edu"Student Conduct",

         "workPhoneobjectStatus" : "(123) 456-7890","ACTIVE"
      },
   "officeLocation" : "123 Benton{ Hall Room
A",         "id":"858b0cab-1326-11e2-818e-406c8f22c3ce",
 "departmentName" : "Engineering & Applied Science" 		  "photoUrlname":"http://192.168.0.151:8080/images/0000000.png"},HS Guidance Counselor",
         "strengthsobjectStatus" : "ACTIVE"Good
test taker",     },
 "abilityToBenefit" : true,    {  
"anticipatedStartTerm" : "Fall",       "anticipatedStartYearid" : "2012"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "actualStartTermname":"FallFaculty / Staff Referral",
         "actualStartYearobjectStatus":2012,"ACTIVE"
      "studentIntakeRequestDate" : 1331269200000},
      "specialServiceGroups"{ : 
         [{"id" : "437f6f2bccadd634-7b1ebd7a-47b411e1-86038d28-9e1208605c0d3368721922dc",
		
         "name":"Ombudsman",
 :   "Basketball Team",	 		   "objectStatus" : "ACTIVE"}
      }
   ],
   "serviceReasons":[  
      "referralSources"{ : 
         [{"id" : "a8c83fd40a640a2a-ee33409d-46ee1271-8d898140-9b2956696f37d0b3878000f6",
		         "name" :"Scholarship "Counseling Services".
		Recipient",
         "objectStatus" : "ACTIVE"},
         ]},
      "serviceReasons"{ : 
         [{"id" : "d95ea02985709794-90c11326-4be011e2-b5478bab-8054fc6914b7406c8f22c3ce"},
		
         "name" : "DevelopmentalAcademically EducationUnprepared",
		
         "objectStatus" : "ACTIVE"}
      },
  ],    {  
"confidentialityLevels" : null,         "permissions" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "currentProgramStatusNamename" : "Active"At-Risk Student",
   
  "registeredForCurrentTerm" : true       "activeAlertsCountobjectStatus":1,"ACTIVE"
      "closedAlertsCount":2},
      "paymentStatus":"Y Y Y",{  
      "registeredTerms":"2013FA 2013SP 2013SU"
	  "residencyCountyid":"Butler205df6c0-fea0-11e1-9678-406c8f22c3ce",
   	  "f1Status":"Y",
	    "gendername":"MCareer Coaching",
	         "maritalStatusobjectStatus":"Single"ACTIVE"
      }
   ],
	   "ethnicityconfidentialityLevels":null,
	   "actionPlanTaskOpenCountpermissions":4null,
 	  "actionPlanTaskClosedCountcurrentProgramStatusName":15,
	  "lastActionPlanCompletedDate":1367297284590
  "Active",
   "formattedStudentIntakeCompleteDateprogramStatusChangeReasonName":null},
   ] }

Returns

Person

Code Block

{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"registeredForCurrentTerm":false,
     "createdDateactiveAlertsCount" : 13312692000002,
  
   "createdByclosedAlertsCount" :
 1,
   "residencyCounty":"DemoCounty",
   {"idf1Status" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Y",
      "gender":"M",
   "firstNamemaritalStatus" : "JohnSeparated",
   "ethnicity":null,
   "race":null,
   "lastNameactionPlanTaskOpenCount":1,
:   "DoeactionPlanTaskClosedCount"}:4,
   "lastActionPlanCompletedDate":1440076479537,
   "modifiedDateconfidentialityDisclosureAgreementSignedDate" : 13312692000001440076476617,
  
   "modifiedByhomeCampus" :{  
       {"id" : "91f46e39901e104b-4dc7-cea843f5-422b-b215-00f6bcf5d280",
   a38e-581015e204e1",
      "name":"North Campus",
      "firstNameobjectStatus" : "JohnACTIVE",
   },
   "formattedCDACompleteDate":"2015-08-20",
   "lastNameformattedStudentIntakeCompleteDate" : "Doe"}, 
null
}

Save a Person

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

Security

PERSON_WRITE

Note

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

Sample Post

Code Block

{  
   "objectStatusid" : "ACTIVE",
 :"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
    "firstNamecreatedDate" : "Sally",
 1356998400000,
    "middleNamecreatedBy":{ : null,
      "lastNameid" : "Student"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "birthDatefirstName" : null"Demo",
      "primaryEmailAddresslastName" : "sally.student@university.eduCoach13",
      "secondaryEmailAddressfullName":"Demo :Coach13"
null,   },
   "usernamemodifiedDate" : "sally.student",
  :1444021202117,
   "homePhonemodifiedBy":{ : "123-456-7890",
      "workPhoneid" : null,
      "cellPhone" : null:"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "nonLocalAddressfirstName" : null"System",
      "addressLine1lastName" : "444 West Third Street"Administrator",
      "fullName"addressLine2:"System :Administrator"
null,   },
   "cityobjectStatus" : "DaytonACTIVE",
  
   "statefirstName" : "OHJames",
      "zipCodemiddleName" : "45402Jacob",
      "alternateAddressLineInUselastName" : null,
  "Anderson",
   "alternateAddressLine1birthDate" : null,
  :"1986-10-24",
   "alternateAddressLine2primaryEmailAddress" : null,
  :"demo@trainingssp.com",
   "alternateAddressCitysecondaryEmailAddress" : null,
  "",
   "alternateAddressStateusername" : null"janderson218",
      "alternateAddressZipCodehomePhone" : null,
  "(555) 555-5412",
   "alternateAddressCountryworkPhone" : null"",
      "photoUrlcellPhone" : null"",

     "schoolIdalternatePhone" : null,
  :"212-555-1212",
   "enablednonLocalAddress" : false,

     "studentIntakeCompleteDateaddressLine1" :"321 null,W. Demo St.",
    "studentTypeaddressLine2" :
  "Apt. 214",
      {"idcity" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"Phoenix",
   "state":"AZ",
      "namezipCode" :"55555 "Early Alert"   ",
   "alternateAddressInUse":false,
   "objectStatusalternateAddressLine1":"ACTIVE"},},
   "alternateAddressLine2":"",
   "coachalternateAddressCity" :"",
   "alternateAddressState":"  ",
   {"alternateAddressZipCode"id:"  : "91f46e39-cea8-422b-b215-00f6bcf5d280",       ",
   "firstNamealternateAddressCountry" : "Amy",
   "photoUrl":null,
   "schoolId":"janderson218",
   "lastNameenabled":true,
  : "AdvisorstudentIntakeCompleteDate":null,
   "studentType":{  
      "primaryEmailAddressid" : "amy.advisor@university.edu",
   "0a640a2a-409d-1271-8140-d0af4a4200ef",
      "workPhonename" : "(123) 456-7890"Non-Degree Seeking",
          "officeLocationobjectStatus" : "ACTIVE"123
Benton Hall Room A"},

         "departmentName" : "Engineering & Applied Science"
		  "photoUrl":"http://192.168.0.151:8080/images/0000000.png"}"coach":{  
      "id":"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
       "strengthsfirstName" : "Good test takerDemo",
      "abilityToBenefitlastName" : true"Coach13",
      "anticipatedStartTermprimaryEmailAddress" : "Falldemo@trainingssp.com",
      "anticipatedStartYearworkPhone" : "2012"(777) 777-7777",
      "actualStartTermofficeLocation":"Fall"null,
      "actualStartYeardepartmentName":2012null,
      "studentIntakeRequestDatehomeCampusName" :"West 1331269200000Campus",
      "specialServiceGroupsphotoUrl" :null
   },
   "abilityToBenefit":true,
   [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
		"anticipatedStartTerm":"",
   "anticipatedStartYear":2011,
   "nameactualStartTerm" : "Basketball TeamFA2011",	
		   "objectStatusactualStartYear" :2011,
"ACTIVE"}   "studentIntakeRequestDate":1440076505197,
   "specialServiceGroups":[  
],      { "referralSources" :
          [{"id" : "a8c83fd4856a3600-ee331326-46ee11e2-8d899b79-9b2956696f37406c8f22c3ce",
		
         "name" :"Student "Counseling Services".
		Athlete",
         "objectStatus" : "ACTIVE"},
         ]},
      "serviceReasons"{ : 
         [{"id" : "d95ea0290a640a2a-90c1409d-4be01271-b5478140-8054fc6914b7d0c138a100fd"},
		   "name" : "Developmental Education", 		   "objectStatusname" : "ACTIVE"}DEI Focus   Group",
     ],       "confidentialityLevelsobjectStatus" : null,:"ACTIVE"
      }
 "permissions" : null],
   "referralSources":[  
"currentProgramStatusName" : "Active",    {  
"registeredForCurrentTerm" : true       "activeAlertsCountid":1"859ff107-1326-11e2-8698-406c8f22c3ce",
      "closedAlertsCount":2,
      "paymentStatusname":"YStudent Y YConduct",
         "registeredTermsobjectStatus":"2013FAACTIVE"
2013SP 2013SU" 	  "residencyCounty":"Butler",
	  "f1Status":"Y",
	  "gender":"M",
	  "maritalStatus":"Single",
	  "ethnicity":null,
	  "actionPlanTaskOpenCount":4,
	  "actionPlanTaskClosedCount":15,
	  "lastActionPlanCompletedDate":1367297284590  },
      {  
         "id":"858b0cab-1326-11e2-818e-406c8f22c3ce",
      "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-943774b4de41","name":"HS Guidance Counselor",
       "createdDate" : 1331269200000  "objectStatus":"ACTIVE"
      },
      { "createdBy" :
         {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",
          "name"firstName:"Faculty / :Staff Referral"John",

         "lastNameobjectStatus" : "DoeACTIVE"},
      },
"modifiedDate" : 1331269200000,    {   "modifiedBy" :
         {"id" : "91f46e39ccadd634-cea8bd7a-422b11e1-b215-00f6bcf5d280",
          "firstName" : "John",
8d28-3368721922dc",
         "lastNamename" : "DoeOmbudsman"},
         "objectStatus" : "ACTIVE",
      "firstName" : "Sally",}
   ],
   "middleNameserviceReasons" :[ null, 
     "lastName" :{ "Student", 
     "birthDate" : null,
      "primaryEmailAddressid" : "sally.student@university.edu"0a640a2a-409d-1271-8140-d0b3878000f6",
      "secondaryEmailAddress" : null,
      "usernamename" :"Scholarship Recipient"sally.student",
       "homePhone" : "123-456-7890",
      "workPhone" : null,objectStatus":"ACTIVE"
      },
 "cellPhone" : null,   {  
 "nonLocalAddress" : null,       "addressLine1id" : "444 West Third Street",:"85709794-1326-11e2-8bab-406c8f22c3ce",
         "addressLine2name" :"Academically nullUnprepared",
         "cityobjectStatus" : "DaytonACTIVE",
      },
"state" : "OH",    {  
"zipCode" : "45402",       "alternateAddressLineInUse" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "alternateAddressLine1name" : null,
      "alternateAddressLine2" : null,"At-Risk Student",
         "alternateAddressCityobjectStatus" :"ACTIVE"
null,      },
"alternateAddressState" : null,    {  
"alternateAddressZipCode" : null,       "alternateAddressCountry" : null,"id":"205df6c0-fea0-11e1-9678-406c8f22c3ce",
         "photoUrlname" :"Career nullCoaching",
         "schoolIdobjectStatus" :"ACTIVE"
null,      }
"enabled"  : false],
      "studentIntakeCompleteDateconfidentialityLevels" : null,
  
   "studentTypepermissions" :
     :null,
   {"idcurrentProgramStatusName" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"Active",
      "programStatusChangeReasonName":null,
   "nameregisteredForCurrentTerm" :false,
"Early Alert"  "activeAlertsCount":2,
    "closedAlertsCount":1,
   "objectStatusresidencyCounty":"ACTIVEDemoCounty"},},
  
   "coachf1Status" :"Y",
     "gender":"M",
   {"idmaritalStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Separated",
   "ethnicity":null,
   "race":null,
   "firstNameactionPlanTaskOpenCount":1,
:   "AmyactionPlanTaskClosedCount":4,
   "lastActionPlanCompletedDate":1440076479537,
   "confidentialityDisclosureAgreementSignedDate":1440076476617,
   "lastNamehomeCampus" : "Advisor",
 :{  
      "primaryEmailAddressid" : "amy.advisor@university.edu",
   "901e104b-4dc7-43f5-a38e-581015e204e1",
      "workPhonename" : "(123) 456-7890North Campus",

         "officeLocationobjectStatus" : "ACTIVE"123
Benton Hall Room A"},
 
        "departmentNameformattedCDACompleteDate" : "Engineering & Applied Science"
		  "photoUrl":"http://192.168.0.151:8080/images/0000000.png"}, 
:"2015-08-20",
   "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",
		  
"name" : "Basketball Team",	 		   "objectStatusfirstName" : "ACTIVESystem"},
         ]"lastName":"Administrator",
      "referralSources"fullName":"System Administrator"
:   },
   "objectStatus":"ACTIVE",
   [{"idfirstName" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"James",
		   "namemiddleName" : "Counseling ServicesJacob".,
		   "objectStatuslastName" : "ACTIVEAnderson"},
   "birthDate":"1986-10-24",
   "primaryEmailAddress":"demo@trainingssp.com",
 ],  "secondaryEmailAddress":"",
    "serviceReasonsusername" : "janderson218",
   "homePhone":"(555) 555-5412",
    [{"idworkPhone" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		   "namecellPhone" : "Developmental Education",
		   "objectStatusalternatePhone" : "ACTIVE"}212-555-1212",
   "nonLocalAddress":false,
   "addressLine1":"321  ]W. Demo St.",
      "confidentialityLevelsaddressLine2" :"Apt. null214",
        "permissionscity" : null,
  "Phoenix",
   "currentProgramStatusNamestate" : "ActiveAZ",
      "registeredForCurrentTerm" : true"zipCode":"55555     ",
   "activeAlertsCountalternateAddressInUse":1false,
      "closedAlertsCountalternateAddressLine1":2"",
 
    "paymentStatusalternateAddressLine2":"Y Y Y",
  
   "registeredTermsalternateAddressCity":""2013FA,
2013SP 2013SU" 	  "residencyCountyalternateAddressState":"Butler  ",
	   "f1StatusalternateAddressZipCode":"Y          ",
 	  "genderalternateAddressCountry":"M",
 	  "maritalStatusphotoUrl":"Single"null,
	   "ethnicityschoolId":null"janderson218",
 	  "actionPlanTaskOpenCountenabled":4true,
	   "actionPlanTaskClosedCountstudentIntakeCompleteDate":15null,
	   "lastActionPlanCompletedDatestudentType":1367297284590{  
    "formattedStudentIntakeCompleteDate":null}   ] }

Returns

Person

Code Block

{"id" : "58ba5ee30a640a2a-734e409d-4ae91271-b9c58140-943774b4de41d0af4a4200ef",
      "createdDatename" : 1331269200000"Non-Degree Seeking",
      "objectStatus"createdBy" ::"ACTIVE"
   },
   "coach":{  
       {"id" : "91f46e3922fc02f1-cea8d8b6-422b496c-b2158e2d-00f6bcf5d28065f6973f888e",
          "firstName" : "JohnDemo",

         "lastName" : "DoeCoach13"},
       "modifiedDateprimaryEmailAddress" : 1331269200000:"demo@trainingssp.com",
      "modifiedByworkPhone" :
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
   "(777) 777-7777",
      "firstNameofficeLocation" : "John"null,
          "lastNamedepartmentName" : "Doe"}null,
       "objectStatushomeCampusName" :"West "ACTIVECampus",
      "firstNamephotoUrl" :null
"Sally",   },
   "middleNameabilityToBenefit" : nulltrue,
  
   "lastNameanticipatedStartTerm" : "Student",
   "anticipatedStartYear":2011,
   "birthDateactualStartTerm" :"FA2011",
null,   "actualStartYear":2011,
   "primaryEmailAddressstudentIntakeRequestDate" : "sally.student@university.edu":1440076505197,
   "specialServiceGroups":[  
"secondaryEmailAddress" : null,    {  
"username" : "sally.student",       "homePhoneid" : "123-456-7890856a3600-1326-11e2-9b79-406c8f22c3ce",
         "workPhonename" :"Student nullAthlete",
         "cellPhoneobjectStatus" :"ACTIVE"
null,       "nonLocalAddress" : null},
      "addressLine1"{ : "444
West Third Street",       "addressLine2" : null,id":"0a640a2a-409d-1271-8140-d0c138a100fd",
         "cityname":"DEI :Focus Group"Dayton",
         "stateobjectStatus" : "OHACTIVE",
      }
"zipCode"  : "45402"],
   "referralSources":[  
"alternateAddressLineInUse" : null,    {  
"alternateAddressLine1" : null,       "alternateAddressLine2" : null,"id":"859ff107-1326-11e2-8698-406c8f22c3ce",
         "alternateAddressCityname" :"Student nullConduct",
         "alternateAddressStateobjectStatus" :"ACTIVE"
null,      },
"alternateAddressZipCode" : null,    {  
"alternateAddressCountry" : null,       "photoUrl" : null,"id":"858b0cab-1326-11e2-818e-406c8f22c3ce",
         "name"schoolId:"HS :Guidance nullCounselor",
         "enabledobjectStatus" : false,:"ACTIVE"
      "studentIntakeCompleteDate" : null},
      "studentType"{  :
         {"id" : "ce0d041df6201a04-d3acbb31-42a14ca5-9085b606-7f744240e07e609f3ad09f87",

         "name":"Faculty :/ "EarlyStaff AlertReferral"
,
         "objectStatus":"ACTIVE"
      },},
      { "coach" :
         {"id" : "91f46e39ccadd634-cea8bd7a-422b11e1-b2158d28-00f6bcf5d2803368721922dc",
          "firstNamename" : "AmyOmbudsman",

         "lastNameobjectStatus" : "AdvisorACTIVE",
      }
   "primaryEmailAddress" : "amy.advisor@university.edu"],
          "workPhone" : "(123) 456-7890",
     "serviceReasons":[  
  "officeLocation" : "123 Benton Hall{ Room A",
          "departmentName" : "Engineering & Applied Science"
		  "photoUrl":"http://192.168.0.151:8080/images/0000000.png"}"id":"0a640a2a-409d-1271-8140-d0b3878000f6",
         "name":"Scholarship Recipient",
         "strengthsobjectStatus" : "ACTIVE"Good
test taker",     },
 "abilityToBenefit" : true,   {  
 "anticipatedStartTerm" : "Fall",       "anticipatedStartYearid" : "2012"85709794-1326-11e2-8bab-406c8f22c3ce",
         "actualStartTermname":"FallAcademically Unprepared",
         "actualStartYearobjectStatus":2012,"ACTIVE"
      "studentIntakeRequestDate" : 1331269200000},
      "specialServiceGroups"{ : 
         [{"id" : "437f6f2bf6201a04-7b1ebb31-47b44ca5-8603b606-9e1208605c0d609f3ad09f87",
		         "name" : "BasketballAt-Risk TeamStudent",	
		
         "objectStatus" : "ACTIVE"}
         ]},
      "referralSources"{ : 
         [{"id" : "a8c83fd4205df6c0-ee33fea0-46ee11e1-8d899678-9b2956696f37406c8f22c3ce",
		
         "name" :"Career "Counseling Services".
		Coaching",
         "objectStatus" : "ACTIVE"},
      }
   ],
      "serviceReasonsconfidentialityLevels" :null,
      "permissions":null,
   [{"idcurrentProgramStatusName" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}"Active",
		   "nameprogramStatusChangeReasonName" : "Developmental Education":null,
		   "objectStatusregisteredForCurrentTerm" :false,
"ACTIVE"}   "activeAlertsCount":2,
      ],
  "closedAlertsCount":1,
   "confidentialityLevelsresidencyCounty" : null"DemoCounty",
   "f1Status":"Y",
    "permissionsgender" : null,
  "M",
   "currentProgramStatusNamemaritalStatus" : "ActiveSeparated",
  
   "registeredForCurrentTermethnicity" :null,
true   "race":null,
   "activeAlertsCountactionPlanTaskOpenCount":1,
   "actionPlanTaskClosedCount":4,
   "closedAlertsCountlastActionPlanCompletedDate":21440076479537,
  
   "paymentStatusconfidentialityDisclosureAgreementSignedDate":"Y Y Y"1440076476617,
      "registeredTermshomeCampus":"2013FA{  2013SP
2013SU" 	  "residencyCounty":"Butler", 	  "f1Statusid":"Y901e104b-4dc7-43f5-a38e-581015e204e1",
	   "gender":"M", 	  "maritalStatusname":"SingleNorth Campus",
 	  "ethnicity":null, 	  "actionPlanTaskOpenCountobjectStatus":4,"ACTIVE"
	  "actionPlanTaskClosedCount":15,
	 },
   "lastActionPlanCompletedDateformattedCDACompleteDate":1367297284590
 "2015-08-20",
    "formattedStudentIntakeCompleteDate":null} 
 ]
}n

Delete a Person

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

...

Code Block
{"success" : "false", "message" : "Message when success is false."}

Get History for Person

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

Security

PERSON_READ

Parameters

status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

PDF Report

Versions Compared

Old Version 51

New Version Current

Key

Get All Persons Who Are Coaches

Get All Persons Who Are Coaches

Get a Person

Get a Person by School ID

Get a Person

Create a Person

Get a Person by School ID

Create a Person

Save a Person

Save a Person

Delete a Person

Get History for Person