Versions Compared

Old Version 52

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" : null,
:"1986-10-24",
     "primaryEmailAddress" : "sallydemo@trainingssp.student@university.educom",

     "secondaryEmailAddress" : null"",
      "username" : "sally.studentjanderson218",
 
    "homePhone" : "123-456-7890",
 "(555) 555-5412",
    "workPhone" : null"",

     "cellPhone" :"",
null,   "alternatePhone":"212-555-1212",
   "nonLocalAddress" : nullfalse,
      "addressLine1" : "444321 WestW. ThirdDemo StreetSt.",
  
   "addressLine2" :"Apt. null214",
 
    "city" : "DaytonPhoenix",
 
    "state" : "OHAZ",
 
    "zipCode" : "45402","55555     ",
   "alternateAddressLineInUsealternateAddressInUse" : nullfalse,
      "alternateAddressLine1" : null,
  "",
   "alternateAddressLine2" : null,
  "",
   "alternateAddressCity" : null"",
      "alternateAddressState":" : null",
 
    "alternateAddressZipCode" :" null,       "alternateAddressCountry" : null",
   "alternateAddressCountry":"",
   "photoUrl" : null,

     "schoolId" : null,
  "janderson218",
   "enabled" : falsetrue,
  
   "studentIntakeCompleteDate" : null,
  
   "studentType" :{  
       {"id" : "ce0d041d0a640a2a-d3ac409d-42a11271-90858140-7f744240e07ed0af4a4200ef",
   
      "name" : "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"}, 
      "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   "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"firstName:"Faculty / :Staff "CamdenReferral",
         "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 Recipient"John",
          "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : 1331269200000,},
      {  "modifiedBy"
:
         {"id" : "91f46e3985709794-cea81326-422b11e2-b2158bab-00f6bcf5d280406c8f22c3ce",

         "firstNamename" :"Academically "JohnUnprepared",

         "lastNameobjectStatus" : "Doe"ACTIVE"
      },
      {  "objectStatus"
 : "ACTIVE",       "firstNameid" : "Sally"f6201a04-bb31-4ca5-b606-609f3ad09f87",
      "middleName" : null,   "name":"At-Risk Student",
         "lastNameobjectStatus" : "StudentACTIVE",
      },
"birthDate" : null,    {  
"primaryEmailAddress" : "sally.student@university.edu",       "secondaryEmailAddress" : null,"id":"205df6c0-fea0-11e1-9678-406c8f22c3ce",
         "usernamename" : "sally.student"Career Coaching",
         "homePhoneobjectStatus" : "123-456-7890ACTIVE",
      "workPhone" : null,}
   ],
   "cellPhoneconfidentialityLevels" : null,
  
   "nonLocalAddresspermissions" : null,
      "addressLine1currentProgramStatusName" :"Active",
"444 West Third Street"programStatusChangeReasonName":null,
  
   "addressLine2registeredForCurrentTerm" : nullfalse,
   "activeAlertsCount":2,
   "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-7f744240e07e",
          "name" : "Early Alert"
      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",
   "objectStatusmiddleName":"ACTIVEJacob"},},
      "coachlastName" :
  :"Anderson",
      {"idbirthDate" : "91f46e391986-cea8-422b-b215-00f6bcf5d28010-24",
          "firstName" : "Amy",
      "primaryEmailAddress":"demo@trainingssp.com",
   "lastNamesecondaryEmailAddress" : "Advisor",
          "primaryEmailAddress" : "amy.advisor@university.edu",
      "username":"janderson218",
   "workPhonehomePhone" : "(123555) 456555-78905412",
    "workPhone":"",
     "officeLocationcellPhone" : ""123,
Benton Hall Room A "alternatePhone":"212-555-1212",
   "nonLocalAddress":false,
      "departmentNameaddressLine1" : "Engineering321 &W. AppliedDemo ScienceSt.",
		   "photoUrladdressLine2":"http://192.168.0.151:8080/images/0000000.png"}Apt. 214",
   "city":"Phoenix",
   "strengthsstate" : "Good test takerAZ",
      "abilityToBenefit" : true,"zipCode":"55555     ",
   "anticipatedStartTermalternateAddressInUse" : "Fall",
  false,
   "anticipatedStartYearalternateAddressLine1" : "2012",
  
   "actualStartTermalternateAddressLine2":"Fall",
      "actualStartYearalternateAddressCity":2012"",
      "studentIntakeRequestDate"alternateAddressState":" : 1331269200000",
    "alternateAddressZipCode":"  "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",
         [{"idfirstName" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		"Demo",
      "namelastName" : "Developmental EducationCoach13",
   		   "objectStatusprimaryEmailAddress" : "ACTIVEdemo@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":"2013FA 2013SP 2013SU"
	2011,
   "residencyCountystudentIntakeRequestDate":"Butler"1440076505197,
	   "f1Status":"Y",
	  "gender":"M",
	  "maritalStatus":"Single",
	  "ethnicity":null,
	  "actionPlanTaskOpenCount":4,
	  "actionPlanTaskClosedCount":15,
	  "lastActionPlanCompletedDate":1367297284590specialServiceGroups":[  
      {  
         "id":"856a3600-1326-11e2-9b79-406c8f22c3ce",
         "name":"Student Athlete",
         "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",
         "objectStatus"createdBy" ::"ACTIVE"
      }
   ],
   "referralSources":[  
      {  
 {        "id" : "91f46e39859ff107-cea81326-422b11e2-b2158698-00f6bcf5d280406c8f22c3ce",

         "firstNamename" :"Student Conduct"John",

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

         "lastNameobjectStatus" : "DoeACTIVE"},
      },
"objectStatus" : "ACTIVE",    {  
"firstName" : "Sally",       "middleName" : null,"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "name"lastName:"Faculty / :Staff "StudentReferral",
         "birthDateobjectStatus" :"ACTIVE"
null,      },
"primaryEmailAddress" : "sally.student@university.edu",    {  
"secondaryEmailAddress" : null,       "usernameid" : "sally.student","ccadd634-bd7a-11e1-8d28-3368721922dc",
         "homePhonename" : "123-456-7890Ombudsman",
         "workPhoneobjectStatus" :"ACTIVE"
null,      }
"cellPhone"  : null],
   "serviceReasons":[   "nonLocalAddress"
: null,     {  "addressLine1"
: "444 West Third Street",     "id":"0a640a2a-409d-1271-8140-d0b3878000f6",
 "addressLine2" : null,
      "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,       "alternateAddressCountry" : null,id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "photoUrlname" : null"At-Risk Student",
      "schoolId" : null,
      "enabledobjectStatus" :"ACTIVE"
false,      },
"studentIntakeCompleteDate" : null,    {  
"studentType" :          {"id" : "ce0d041d205df6c0-d3acfea0-42a111e1-90859678-7f744240e07e406c8f22c3ce",

         "name" : "EarlyCareer AlertCoaching",
          "objectStatus":"ACTIVE"},},
      }
"coach" :  ],
   "confidentialityLevels":null,
   {"idpermissions" : "91f46e39-cea8-422b-b215-00f6bcf5d280":null,
      "currentProgramStatusName":"Active",
   "firstNameprogramStatusChangeReasonName":null,
  : "AmyregisteredForCurrentTerm":false,
   "activeAlertsCount":2,
   "closedAlertsCount":1,
   "lastNameresidencyCounty" : "AdvisorDemoCounty",
    
     "primaryEmailAddressf1Status" : "amy.advisor@university.eduY",
     
    "workPhonegender" : "(123) 456-7890"M",
 
        "officeLocationmaritalStatus" : "Separated"123,
Benton Hall Room A"ethnicity":null,
     "race":null,
    "departmentNameactionPlanTaskOpenCount" :1,
"Engineering & Applied Science"actionPlanTaskClosedCount":4,
		   "photoUrl":"http://192.168.0.151:8080/images/0000000.png"}lastActionPlanCompletedDate":1440076479537,
   "confidentialityDisclosureAgreementSignedDate":1440076476617,
   "strengthshomeCampus" :{ "Good test
taker",       "abilityToBenefitid" : true:"901e104b-4dc7-43f5-a38e-581015e204e1",
      "anticipatedStartTermname" :"North Campus"Fall",
      "anticipatedStartYearobjectStatus" : "2012ACTIVE",
   },
   "actualStartTermformattedCDACompleteDate":"Fall2015-08-20",
   "formattedStudentIntakeCompleteDate":null
}

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",
		   "name" : "Counseling Services".
		   "objectStatusfirstName" : "ACTIVESystem"},
         ]"lastName":"Administrator",
      "serviceReasonsfullName" :"System Administrator"
     },
   [{"idobjectStatus" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}"ACTIVE",
		   "namefirstName" : "Developmental EducationJames",
		   "objectStatusmiddleName" : "ACTIVEJacob"},
   "lastName":"Anderson",
     ],
  "birthDate":"1986-10-24",
   "confidentialityLevelsprimaryEmailAddress" : null:"demo@trainingssp.com",
        "permissionssecondaryEmailAddress" : null,
  :"",
   "currentProgramStatusNameusername" : "Activejanderson218",
      "registeredForCurrentTermhomePhone" : true
"(555) 555-5412",
     "activeAlertsCountworkPhone":1"",
  
   "closedAlertsCountcellPhone":2"",
      "paymentStatusalternatePhone":"Y Y Y212-555-1212",
   "nonLocalAddress":false,
   "registeredTermsaddressLine1":"2013FA 2013SP 2013SU"
	321 W. Demo St.",
   "residencyCountyaddressLine2":"ButlerApt. 214",
	   "f1Statuscity":"YPhoenix",
 	  "genderstate":"MAZ",
 	  "maritalStatuszipCode":"Single55555     ",
	   "ethnicityalternateAddressInUse":nullfalse,
	   "actionPlanTaskOpenCountalternateAddressLine1":4"",
 	  "actionPlanTaskClosedCountalternateAddressLine2":15"",
	   "lastActionPlanCompletedDatealternateAddressCity":1367297284590
  "",
   "formattedStudentIntakeCompleteDatealternateAddressState":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",",
   "alternateAddressZipCode":"        "middleName" : null",
      "lastNamealternateAddressCountry" : "Student",
  ,
   "birthDatephotoUrl" : null,

     "primaryEmailAddressschoolId" : "sally.student@university.edujanderson218",
   "enabled":true,
   "secondaryEmailAddressstudentIntakeCompleteDate" : null,
  
   "usernamestudentType":{ : "sally.student",
      "homePhoneid" : "123-456-78900a640a2a-409d-1271-8140-d0af4a4200ef",
      "workPhonename" : null"Non-Degree Seeking",
      "cellPhoneobjectStatus" : null,
      "nonLocalAddress"ACTIVE"
: null,   },
   "addressLine1coach" :{ "444 West
Third Street",       "addressLine2id" : null:"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "cityfirstName" : "DaytonDemo",
      "statelastName" : "OHCoach13",
      "zipCodeprimaryEmailAddress" : "45402demo@trainingssp.com",
      "alternateAddressLineInUseworkPhone" : null"(777) 777-7777",
      "alternateAddressLine1officeLocation" : null,
      "alternateAddressLine2departmentName" : null,
      "alternateAddressCityhomeCampusName" :"West nullCampus",
      "alternateAddressStatephotoUrl" :null
null,   },
   "alternateAddressZipCodeabilityToBenefit" : nulltrue,
   "anticipatedStartTerm":"",
   "alternateAddressCountryanticipatedStartYear" : null2011,
  
   "photoUrlactualStartTerm" : null,
  "FA2011",
   "schoolIdactualStartYear" : null2011,
      "enabledstudentIntakeRequestDate" : false1440076505197,
  
   "studentIntakeCompleteDatespecialServiceGroups":[ : 
null,      { "studentType" :
         {"id" : "ce0d041d856a3600-d3ac1326-42a111e2-90859b79-7f744240e07e406c8f22c3ce",
          "name" : "EarlyStudent AlertAthlete"
,
         "objectStatus":"ACTIVE"
      },},
      { "coach" :
         {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0c138a100fd",
          "name"firstName:"DEI :Focus Group"Amy",

         "lastNameobjectStatus" : "AdvisorACTIVE",
      }
   "primaryEmailAddress" : "amy.advisor@university.edu",
  ],
       "workPhonereferralSources" : "(123) 456-7890",
   :[  
    "officeLocation" : "123{ Benton Hall
Room A",        "id":"859ff107-1326-11e2-8698-406c8f22c3ce",
  "departmentName" : "Engineering & Applied Science" 		  "photoUrlname":"http://192.168.0.151:8080/images/0000000.png"},Student Conduct",
         "strengthsobjectStatus" : "ACTIVE"Good
test taker",      },
"abilityToBenefit" : 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-9e1208605c0d609f3ad09f87",
		
         "name":"Faculty :/ "BasketballStaff TeamReferral",	
		
         "objectStatus" : "ACTIVE"}
         ]},
      "referralSources"{ : 
         [{"id" : "a8c83fd4ccadd634-ee33bd7a-46ee11e1-8d898d28-9b2956696f373368721922dc",
		         "name":"Ombudsman",
  "name" : "Counseling Services". 		   "objectStatus" : "ACTIVE"},
      }
   ],
   "serviceReasons":[  
      "serviceReasons"{ : 
         [{"id" : "d95ea0290a640a2a-90c1409d-4be01271-b5478140-8054fc6914b7d0b3878000f6"},
		
         "name" : "DevelopmentalScholarship EducationRecipient",
		
         "objectStatus" : "ACTIVE"
      },
      {  
 ],        "confidentialityLevelsid" : null,:"85709794-1326-11e2-8bab-406c8f22c3ce",
         "permissions" : null,"name":"Academically Unprepared",
         "currentProgramStatusNameobjectStatus" : "ActiveACTIVE",
      },
 "registeredForCurrentTerm"  : true  {  
  "activeAlertsCount":1,       "closedAlertsCountid":2,"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "paymentStatusname":"Y Y YAt-Risk Student",
         "registeredTermsobjectStatus":"ACTIVE"2013FA
  2013SP 2013SU" 	  "residencyCounty":"Butler",
	  "f1Status":"Y",
	  "gender":"M",
	  "maritalStatus":"Single",
	  "ethnicity":null,
	  "actionPlanTaskOpenCount":4,
	  "actionPlanTaskClosedCount":15,
	  "lastActionPlanCompletedDate":1367297284590},
      {  
         "id":"205df6c0-fea0-11e1-9678-406c8f22c3ce",
         "name":"Career Coaching",
         "formattedStudentIntakeCompleteDateobjectStatus":null} 
 ]
}

Returns

Person

Code Block
{"id"ACTIVE"
: "58ba5ee3-734e-4ae9-b9c5-943774b4de41",     }
 "createdDate" : 1331269200000],
   "confidentialityLevels":null,
   "createdBypermissions" :null,
   "currentProgramStatusName":"Active",
   "programStatusChangeReasonName":null,
 {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",registeredForCurrentTerm":false,
   "activeAlertsCount":2,
   "closedAlertsCount":1,
   "firstNameresidencyCounty" : "JohnDemoCounty",
      "f1Status":"Y",
   "lastNamegender" : "DoeM"},
   "maritalStatus":"Separated",
   "modifiedDateethnicity" : 1331269200000null,
  
   "modifiedByrace" :null,
    "actionPlanTaskOpenCount":1,
    {"idactionPlanTaskClosedCount" : "91f46e39-cea8-422b-b215-00f6bcf5d280":4,
      "lastActionPlanCompletedDate":1440076479537,
   "firstNameconfidentialityDisclosureAgreementSignedDate" : "John"1440076476617,
          "lastName" : "Doe"},"homeCampus":{  
      "objectStatusid" : "ACTIVE"901e104b-4dc7-43f5-a38e-581015e204e1",
      "firstNamename" :"North "SallyCampus",
      "middleNameobjectStatus" :"ACTIVE"
null,   },
   "lastNameformattedCDACompleteDate" : "Student2015-08-20",
      "birthDateformattedStudentIntakeCompleteDate" : null,
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
{  
   "primaryEmailAddressid" : "sally.student@university.edu"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
   "createdDate":1356998400000,
   "secondaryEmailAddresscreatedBy":{ : null,
      "usernameid" : "sally.student"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "homePhonefirstName" : "123-456-7890Demo",
      "workPhonelastName" : null"Coach13",
      "fullName"cellPhone:"Demo :Coach13"
null,   },
   "nonLocalAddressmodifiedDate" : null1444021202117,
  
   "addressLine1modifiedBy" :{ "444 West
Third Street",       "addressLine2id" : null:"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "cityfirstName" : "DaytonSystem",
      "statelastName" : "OHAdministrator",
      "zipCodefullName" :"System Administrator"45402",
   },
   "alternateAddressLineInUseobjectStatus" : null"ACTIVE",
   "firstName":"James",
   "alternateAddressLine1middleName" :"Jacob",
null,   "lastName":"Anderson",
   "alternateAddressLine2birthDate" : null:"1986-10-24",
   "primaryEmailAddress":"demo@trainingssp.com",
   "alternateAddressCitysecondaryEmailAddress" : null,
  "",
   "alternateAddressStateusername" : null"janderson218",
      "alternateAddressZipCode" : null,
  "homePhone":"(555) 555-5412",
   "alternateAddressCountryworkPhone" : null"",
      "photoUrlcellPhone" : null"",

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

     "studentIntakeCompleteDateaddressLine1" :"321 null,W. Demo  St.",
   "studentTypeaddressLine2" :"Apt. 214",
    "city":"Phoenix",
   {"idstate" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"AZ",
   "zipCode":"55555     ",
 "name" : "Early Alert"
alternateAddressInUse":false,
   "alternateAddressLine1":"",
     "objectStatusalternateAddressLine2":"ACTIVE"},},
 
    "coachalternateAddressCity" :"",
   "alternateAddressState":"  ",
   {"alternateAddressZipCode"id:" : "91f46e39-cea8-422b-b215-00f6bcf5d280",         ",
   "firstNamealternateAddressCountry" : "Amy",
    "photoUrl":null,
     "lastNameschoolId" : "Advisorjanderson218",
   "enabled":true,
   "studentIntakeCompleteDate":null,
   "primaryEmailAddressstudentType" : "amy.advisor@university.edu",{  
         "workPhoneid" : "(123) 456-7890",
   "0a640a2a-409d-1271-8140-d0af4a4200ef",
      "officeLocationname" :"Non-Degree Seeking"123,
Benton Hall Room A",   "objectStatus":"ACTIVE"
   },
   "departmentNamecoach":{ : 
"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",
      "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-9b2956696f37",
		406c8f22c3ce",
         "name" :"Student "Counseling Services".
		Athlete",
         "objectStatus" : "ACTIVE"},
         ]},
      "serviceReasons"{ : 
         [{"id" : "d95ea0290a640a2a-90c1409d-4be01271-b5478140-8054fc6914b7d0c138a100fd"},
		
  "name" : "Developmental Education", 		   "objectStatusname" : "ACTIVE"}DEI Focus   Group",
     ],       "confidentialityLevelsobjectStatus" :"ACTIVE"
null,      }
  "permissions" : null ],
   "referralSources":[  
"currentProgramStatusName" : "Active",    {  
"registeredForCurrentTerm" : true       "activeAlertsCountid":1"859ff107-1326-11e2-8698-406c8f22c3ce",
         "closedAlertsCountname":2"Student Conduct",
         "paymentStatusobjectStatus":"ACTIVE"Y
   Y Y",  },
    "registeredTerms":"2013FA 2013SP 2013SU"{ 	 
"residencyCounty":"Butler", 	  "f1Status":"Y", 	  "gender":"M", 	  "maritalStatusid":"Single858b0cab-1326-11e2-818e-406c8f22c3ce",
	  "ethnicity":null, 	  "actionPlanTaskOpenCount":4,
	  "actionPlanTaskClosedCount":15, 	  "lastActionPlanCompletedDatename":1367297284590"HS Guidance Counselor",
      "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","objectStatus":"ACTIVE"
      "createdDate"},
: 1331269200000,     {  "createdBy"
:          {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",
          "name"firstName:"Faculty / :Staff "JohnReferral",

         "lastNameobjectStatus" : "DoeACTIVE"},
      },
"modifiedDate" : 1331269200000,    {  
"modifiedBy" :          {"id" : "91f46e39ccadd634-cea8bd7a-422b11e1-b2158d28-00f6bcf5d2803368721922dc",

         "firstNamename" : "JohnOmbudsman",

         "lastName" : "Doe"},        "objectStatus" : "ACTIVE",
      "firstName"}
: "Sally",  ],
    "middleNameserviceReasons" : null,
 [  
  "lastName" : "Student",    {  
"birthDate" : null,       "primaryEmailAddressid" : "sally.student@university.edu","0a640a2a-409d-1271-8140-d0b3878000f6",
         "secondaryEmailAddressname" :"Scholarship nullRecipient",
         "usernameobjectStatus" : "sally.studentACTIVE",
      "homePhone" : "123-456-7890",},
      {  
"workPhone" : null,       "cellPhone" : null,"id":"85709794-1326-11e2-8bab-406c8f22c3ce",
         "nonLocalAddressname" :"Academically nullUnprepared",
         "objectStatus":"addressLine1ACTIVE"
:   "444 West Third Street"},
      { "addressLine2" 
 : null,       "cityid" : "Dayton","f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "statename" :"At-Risk Student"OH",
         "zipCodeobjectStatus" : "45402ACTIVE",
      "alternateAddressLineInUse" : null,},
      {  
"alternateAddressLine1" : null,       "alternateAddressLine2" : null,id":"205df6c0-fea0-11e1-9678-406c8f22c3ce",
         "alternateAddressCityname" :"Career nullCoaching",
         "alternateAddressState" : null,objectStatus":"ACTIVE"
      }
   ],
   "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,
     "namerace" :null,
"Early Alert"   "actionPlanTaskOpenCount":1,
   "actionPlanTaskClosedCount":4,
   "objectStatuslastActionPlanCompletedDate":"ACTIVE"},},1440076479537,
   "confidentialityDisclosureAgreementSignedDate":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,
   "createdBy":{  
      "departmentNameid" : "Engineering & Applied Science"
		:"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "photoUrlfirstName":"http://192.168.0.151:8080/images/0000000.png"}Demo",
       "strengthslastName" : "Good test takerCoach13",
      "fullName"abilityToBenefit:"Demo :Coach13"
true,   },
   "anticipatedStartTermmodifiedDate" : "Fall",
  1444021202117,
   "anticipatedStartYearmodifiedBy":{ : "2012",
      "actualStartTermid":"Fall58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "actualStartYearfirstName":2012"System",
      "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",
   "secondaryEmailAddress":"",
   [{"idusername" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"janderson218",
		   "namehomePhone" : "Counseling Services".
		(555) 555-5412",
   "objectStatusworkPhone" : "ACTIVE"},
   "cellPhone":"",
     ],
"alternatePhone":"212-555-1212",
     "serviceReasonsnonLocalAddress" :false,
   "addressLine1":"321 W. Demo St.",
   [{"idaddressLine2" :"Apt. "d95ea029-90c1-4be0-b547-8054fc6914b7"}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",
      "createdBylastName" :
  :"Coach13",
      {"idprimaryEmailAddress" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
   "demo@trainingssp.com",
      "firstNameworkPhone" : "John"(777) 777-7777",
      "officeLocation":null,
   "lastName"  : "DoedepartmentName"}:null, 
      "modifiedDatehomeCampusName" :"West 1331269200000Campus",
      "modifiedByphotoUrl" :null
   },
   "abilityToBenefit":true,
 {  "idanticipatedStartTerm" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
   "anticipatedStartYear":2011,
      "firstNameactualStartTerm" : "JohnFA2011",
   "actualStartYear":2011,
   "studentIntakeRequestDate":1440076505197,
   "lastNamespecialServiceGroups":[  
: "Doe"},     {  
"objectStatus" : "ACTIVE",       "firstNameid" : "Sally"856a3600-1326-11e2-9b79-406c8f22c3ce",
      "middleName" : null,       "lastName" : "Student"name":"Student Athlete",
         "birthDateobjectStatus" :"ACTIVE"
null,      },
"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}

...