Versions Compared

Old Version 55

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.

...

Info

Changelog:

  • registeredTerms removed starting in v2.4.0
  • paymentTerms removed started 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"modifiedDate:"Demo :Coach13"
1331269200000,   },
   "modifiedBy" :
modifiedDate":1444021202117,
   "modifiedBy":{  
      {"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",

         "firstName" : "JohnSystem",
      "lastName":"Administrator",
      "lastNamefullName" :"System "DoeAdministrator"},
   },
   "objectStatus" : "ACTIVE",
      "firstName" : "SallyJames",

     "middleName" : null"Jacob",
      "lastName" : "StudentAnderson",
  
   "birthDate" : "19831986-0810-2024",
  
   "primaryEmailAddress" : "sallydemo@trainingssp.student@university.educom",
 
    "secondaryEmailAddress" : null"",

     "username" : "sally.studentjanderson218",
  
   "homePhone" : "123-456-7890",
  "(555) 555-5412",
   "workPhone" : null,
  "",
   "cellPhone" : null"",
   "alternatePhone":"212-555-1212",
   "nonLocalAddress" : nullfalse,
 
    "addressLine1" : "444321 WestW. ThirdDemo StreetSt.",
 
    "addressLine2" :"Apt. null214",
  
   "city" : "DaytonPhoenix",
      "state" : "OHAZ",
  
   "zipCode":"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,
      "officeLocationdepartmentName":null,
:   "123 Benton Hall Room A "homeCampusName":"West Campus",
      "photoUrl":null
   "departmentName"},
: "Engineering & Applied Science"
		 "abilityToBenefit":true,
   "photoUrlanticipatedStartTerm":"http://192.168.0.151:8080/images/0000000.png"}",
   "anticipatedStartYear":2011,
   "actualStartTerm":"strengthsFA2011",
: "Good test taker"actualStartYear":2011,
   "studentIntakeRequestDate":1440076505197,
   "abilityToBenefitspecialServiceGroups":[  
: true,     {  "anticipatedStartTerm"
 : "Fall",       "anticipatedStartYearid" : "2012"856a3600-1326-11e2-9b79-406c8f22c3ce",
         "actualStartTermname":"FallStudent Athlete",
         "actualStartYearobjectStatus":2012,"ACTIVE"
      "studentIntakeRequestDate" : 1331269200000,},
      { "specialServiceGroups" : 
         [{"id" : "437f6f2b0a640a2a-7b1e409d-47b41271-86038140-9e1208605c0dd0c138a100fd",
		         "name" :"DEI "BasketballFocus TeamGroup",	
		
         "objectStatus" : "ACTIVE"}
      }
   ],
   "referralSources":[  
     "referralSources" { : 
         [{"id" : "a8c83fd4859ff107-ee331326-46ee11e2-8d898698-9b2956696f37406c8f22c3ce",
		
         "name" :"Student "Counseling Services".
		Conduct",
         "objectStatus" : "ACTIVE"},
         ]},
      "serviceReasons"{ : 
         [{"id" : "d95ea029858b0cab-90c11326-4be011e2-b547818e-8054fc6914b7406c8f22c3ce"},
		         "name" :"HS "DevelopmentalGuidance EducationCounselor",
		
         "objectStatus" : "ACTIVE"
      },
      {  
 ],        "confidentialityLevelsid" : null,:"f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "name"permissions:"Faculty : null,/ Staff Referral",
         "currentProgramStatusNameobjectStatus" : "ActiveACTIVE",
      "registeredForCurrentTerm"},
: true     {  "activeAlertsCount":1,
      "closedAlertsCount":2, 	  "residencyCountyid":"Butlerccadd634-bd7a-11e1-8d28-3368721922dc",
	         "f1Statusname":"YOmbudsman",
	
         "genderobjectStatus":"M",
	ACTIVE"
      }
   ],
   "maritalStatus":"Single",
	  "ethnicity":null,serviceReasons":[  
      {  
         "raceid":null"0a640a2a-409d-1271-8140-d0b3878000f6",
	      "actionPlanTaskOpenCount":4, 	  "actionPlanTaskClosedCountname":15"Scholarship Recipient",
	  "lastActionPlanCompletedDate":1367297284590       "formattedStudentIntakeCompleteDateobjectStatus":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"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",
       "firstName" : "Christina",
    "name":"Ombudsman",
         "objectStatus":"ACTIVE"
      }
   ],
   "lastNameserviceReasons":[ : "Coach"}, 
      {  ...
    ] }

 

Get a Person

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

Security

PERSON_READ

Returns

Person

Code Block
    [{"id" : "58ba5ee30a640a2a-734e409d-4ae91271-b9c58140-943774b4de41d0b3878000f6",
         "createdDatename" :"Scholarship 1331269200000Recipient",
         "createdByobjectStatus":"ACTIVE"
 :     },
      {  
         "id" : "91f46e3985709794-cea81326-422b11e2-b2158bab-00f6bcf5d280406c8f22c3ce",

         "firstNamename" :"Academically Unprepared"John",
          "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : 1331269200000,},
      { "modifiedBy" :
         {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",

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

         "lastName" : "Doe"}, 
      "objectStatus" : "ACTIVE",
      "firstName" : "Sally"},
      "middleName" : null,
{  
   "lastName" : "Student",       "birthDateid" : "1983-08-20205df6c0-fea0-11e1-9678-406c8f22c3ce",
         "primaryEmailAddressname" : "sally.student@university.edu"Career Coaching",
 
    "secondaryEmailAddress" : null,       "usernameobjectStatus" : "sally.studentACTIVE",
      "homePhone"}
: "123-456-7890",  ],
    "workPhoneconfidentialityLevels" : null,
      "cellPhonepermissions" : null,
   "currentProgramStatusName":"Active",
   "nonLocalAddressprogramStatusChangeReasonName" : null,
      "addressLine1registeredForCurrentTerm" :false,
"444 West Third Street"activeAlertsCount":2,
  
   "addressLine2closedAlertsCount" : null1,
  
   "cityresidencyCounty" : "DaytonDemoCounty",

     "statef1Status" : "OHY",
  
   "zipCodegender" : "45402M",
  
   "alternateAddressLineInUsemaritalStatus" : null"Separated",

     "alternateAddressLine1ethnicity" : null,

     "alternateAddressLine2race" : null,

     "alternateAddressCityactionPlanTaskOpenCount" : null1,
  
   "alternateAddressStateactionPlanTaskClosedCount" : null4,
      "alternateAddressZipCodelastActionPlanCompletedDate" : null1440076479537,
  
   "alternateAddressCountryconfidentialityDisclosureAgreementSignedDate" : null1440076476617,

     "photoUrlhomeCampus":{ : null,
      "schoolIdid" : null:"901e104b-4dc7-43f5-a38e-581015e204e1",
      "enabledname" :"North falseCampus",
      "studentIntakeCompleteDateobjectStatus" : null,
      "studentType"ACTIVE"
:      },
   {"idformattedCDACompleteDate" : "ce0d041d2015-d3ac-42a1-9085-7f744240e07e08-20",
   "formattedStudentIntakeCompleteDate":null
      "name" : "Early Alert"
          "objectStatus":"ACTIVE"},},
  }

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-00f6bcf5d28010-24",
 
        "firstNameprimaryEmailAddress" : "Amydemo@trainingssp.com",
 
        "lastNamesecondaryEmailAddress" : "Advisor",
   
      "primaryEmailAddressusername" : "amy.advisor@university.edujanderson218",
      
   "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",
    "strengthscity" : "Good test takerPhoenix",
  
   "abilityToBenefitstate" : true"AZ",
   "zipCode":"55555   "anticipatedStartTerm" : "Fall",
   "alternateAddressInUse":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",
          [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		"firstName":"Demo",
      "namelastName" : "Developmental EducationCoach13",
   		   "objectStatusprimaryEmailAddress" : "ACTIVEdemo@trainingssp.com"},
         ]"workPhone":"(777) 777-7777",
      "confidentialityLevelsofficeLocation" : null,
        "permissionsdepartmentName" : null,
      "currentProgramStatusNamehomeCampusName" :"West "ActiveCampus",
      "registeredForCurrentTermphotoUrl" :null
true   },
   "activeAlertsCountabilityToBenefit":1true,
      "closedAlertsCountanticipatedStartTerm":2"",
      "registeredTermsanticipatedStartYear":"2013FA2011,
2013SP 2013SU" 	  "residencyCountyactualStartTerm":"ButlerFA2011",
 	  "f1StatusactualStartYear":"Y"2011,
	   "genderstudentIntakeRequestDate":"M"1440076505197,
	   "maritalStatusspecialServiceGroups":"Single",
	  "ethnicity":null,
[  
      {  
   "race":null, 	  "actionPlanTaskOpenCount":4, 	  "actionPlanTaskClosedCountid":15"856a3600-1326-11e2-9b79-406c8f22c3ce",
	  "lastActionPlanCompletedDate":1367297284590       "formattedStudentIntakeCompleteDatename":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
"Student Athlete",
     [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",  "objectStatus":"ACTIVE"
    "createdDate" : 1331269200000},
      "createdBy"{  :
         {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0c138a100fd",
          "name"firstName:"DEI :Focus Group"John",
          "lastNameobjectStatus" : "Doe"},ACTIVE"
      }
   ],
   "modifiedDatereferralSources":[  :
1331269200000,      { "modifiedBy" :
         {"id" : "91f46e39859ff107-cea81326-422b11e2-b2158698-00f6bcf5d280406c8f22c3ce",
          "firstNamename" :"Student "JohnConduct",

         "lastNameobjectStatus" : "DoeACTIVE"},
       "objectStatus" : "ACTIVE",},
      {  
"firstName" : "Sally",       "middleName" : null,id":"858b0cab-1326-11e2-818e-406c8f22c3ce",
         "name"lastName:"HS :Guidance "StudentCounselor",
         "birthDateobjectStatus" : "1983-08-20",ACTIVE"
      },
"primaryEmailAddress" : "sally.student@university.edu",    {  
"secondaryEmailAddress" : null,       "usernameid" : "sally.student","f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "name"homePhone:"Faculty / :Staff "123-456-7890",Referral",
         "workPhoneobjectStatus" :"ACTIVE"
null,      },
"cellPhone" : null,    {  
"nonLocalAddress" : null,       "addressLine1id" : "444 West Third Street",:"ccadd634-bd7a-11e1-8d28-3368721922dc",
         "name"addressLine2:"Ombudsman",
 : null,       "cityobjectStatus" : "DaytonACTIVE",
      "state"}
: "OH",   ],
   "zipCodeserviceReasons" :[ "45402", 
     "alternateAddressLineInUse" :{ null, 
     "alternateAddressLine1" : null,
      "alternateAddressLine2" : null,  "id":"0a640a2a-409d-1271-8140-d0b3878000f6",
         "alternateAddressCityname" :"Scholarship nullRecipient",
         "alternateAddressStateobjectStatus" :"ACTIVE"
null,      },
"alternateAddressZipCode" : null,    {  
"alternateAddressCountry" : null,       "photoUrl" : null,id":"85709794-1326-11e2-8bab-406c8f22c3ce",
         "schoolIdname" :"Academically nullUnprepared",
         "enabledobjectStatus" :"ACTIVE"
false,      },
"studentIntakeCompleteDate" : null,     {  "studentType" :
         {"id" : "ce0d041df6201a04-d3acbb31-42a14ca5-9085b606-7f744240e07e609f3ad09f87",

         "name" : "EarlyAt-Risk AlertStudent"
,
         "objectStatus":"ACTIVE"
      },},
      { "coach" :
         {"id" : "91f46e39205df6c0-cea8fea0-422b11e1-b2159678-00f6bcf5d280406c8f22c3ce",

         "firstNamename" :"Career "AmyCoaching",
          "lastNameobjectStatus" : "AdvisorACTIVE",
      }
   ],
 "primaryEmailAddress" : "amy.advisor@university.edu"confidentialityLevels":null,
          "workPhone" : "(123) 456-7890""permissions":null,
          "officeLocation" : "123 Benton Hall Room A",
      "currentProgramStatusName":"Active",
   "departmentNameprogramStatusChangeReasonName" :null,
"Engineering & Applied Science"
		"registeredForCurrentTerm":false,
   "photoUrl":"http://192.168.0.151:8080/images/0000000.png"}activeAlertsCount":2,
   "closedAlertsCount":1,
   "strengthsresidencyCounty" : "Good test takerDemoCounty",
  
   "abilityToBenefitf1Status" : true"Y",
      "anticipatedStartTermgender" : "FallM",
 
    "anticipatedStartYearmaritalStatus" : "2012Separated",
   "ethnicity":null,
   "actualStartTermrace":"Fall"null,
   "actionPlanTaskOpenCount":1,
   "actualStartYearactionPlanTaskClosedCount":20124,
   "lastActionPlanCompletedDate":1440076479537,
   "studentIntakeRequestDateconfidentialityDisclosureAgreementSignedDate" : 13312692000001440076476617,
      "specialServiceGroupshomeCampus" :{  
        [{"id" : "437f6f2b901e104b-7b1e4dc7-47b443f5-8603a38e-9e1208605c0d581015e204e1",
 		     "name" : "BasketballNorth TeamCampus",	
   		   "objectStatus" : "ACTIVE"}
   },
     ]"formattedCDACompleteDate":"2015-08-20",
      "referralSourcesformattedStudentIntakeCompleteDate" :null
}

Returns

Person

Code Block
{  
       [{"id" : "a8c83fd4d77f4697-ee33ed36-46ee4477-8d89-9b2956696f37",
		b8d0-67c9a1d8b2db",
   "createdDate":1356998400000,
   "namecreatedBy":{  :
 "Counseling Services". 		   "objectStatusid" : "ACTIVE"}"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
         ]"firstName":"Demo",
      "serviceReasonslastName" :"Coach13",
      "fullName":"Demo Coach13"
  [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		   "namemodifiedDate" : "Developmental Education":1444021202117,
		   "objectStatusmodifiedBy" :{ "ACTIVE"} 
        ]"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "confidentialityLevelsfirstName" : null"System",
        "permissionslastName" : null"Administrator",
      "currentProgramStatusNamefullName" :"System Administrator"Active",
   },
   "registeredForCurrentTermobjectStatus" :"ACTIVE",
true   "firstName":"James",
   "activeAlertsCountmiddleName":1"Jacob",
   "lastName":"Anderson",
   "closedAlertsCountbirthDate":2"1986-10-24",
	   "residencyCountyprimaryEmailAddress":"Butlerdemo@trainingssp.com",
 	  "f1StatussecondaryEmailAddress":"Y",
	   "genderusername":"Mjanderson218",
	   "maritalStatushomePhone":"Single(555) 555-5412",
 	  "ethnicityworkPhone":null"",
      "race":null,
	"cellPhone":"",
   "actionPlanTaskOpenCountalternatePhone":4,
	"212-555-1212",
   "actionPlanTaskClosedCountnonLocalAddress":15false,
 	  "lastActionPlanCompletedDateaddressLine1":1367297284590"321 W. Demo St.",
   "formattedStudentIntakeCompleteDateaddressLine2":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",
  "Apt. 214",
   "city":"Phoenix",
   "middleNamestate" : null"AZ",
      "lastNamezipCode" : "Student",55555     ",
 "birthDate" : "1983-08-20"alternateAddressInUse":false,
      "primaryEmailAddressalternateAddressLine1" : "sally.student@university.edu",
  
   "secondaryEmailAddressalternateAddressLine2" : null"",
      "usernamealternateAddressCity" : "sally.student",
      "homePhone"alternateAddressState":" : "123-456-7890",

     "workPhonealternateAddressZipCode" :" null,       "cellPhone" : null",
      "nonLocalAddressalternateAddressCountry" : null,
  "",
   "addressLine1photoUrl" :null,
"444 West Third Street "schoolId":"janderson218",
   "enabled":true,
   "addressLine2studentIntakeCompleteDate" : null,
  
   "citystudentType":{ : "Dayton",
      "stateid" : "OH"0a640a2a-409d-1271-8140-d0af4a4200ef",
      "zipCodename" :"Non-Degree Seeking"45402",
      "alternateAddressLineInUseobjectStatus" :"ACTIVE"
null,   },
   "alternateAddressLine1coach":{ : null,
      "alternateAddressLine2id" : null:"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "alternateAddressCityfirstName" : null"Demo",
      "alternateAddressStatelastName" : null"Coach13",
      "alternateAddressZipCodeprimaryEmailAddress" : null:"demo@trainingssp.com",
      "alternateAddressCountryworkPhone" : null"(777) 777-7777",
      "photoUrlofficeLocation" : null,
      "schoolIddepartmentName" : null,
      "enabledhomeCampusName" :"West falseCampus",
      "studentIntakeCompleteDatephotoUrl" : null,
   },
   "studentTypeabilityToBenefit" :true,
         {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"anticipatedStartTerm":"",
   "anticipatedStartYear":2011,
      "nameactualStartTerm" : "Early AlertFA2011",
   "actualStartYear":2011,
   "studentIntakeRequestDate":1440076505197,
   "objectStatusspecialServiceGroups":"ACTIVE"},},[  
      { "coach" :
         {"id" : "91f46e39856a3600-cea81326-422b11e2-b2159b79-00f6bcf5d280406c8f22c3ce",

         "firstNamename" :"Student "AmyAthlete",
          "lastNameobjectStatus" : "AdvisorACTIVE",
      },
     "primaryEmailAddress" : "amy.advisor@university.edu",{  
         "workPhoneid" : "(123) 456-7890",
"0a640a2a-409d-1271-8140-d0c138a100fd",
         "officeLocationname" : "123DEI Benton Hall Room AFocus Group",
          "departmentNameobjectStatus" : "Engineering & Applied Science"ACTIVE"
		  "photoUrl":"http://192.168.0.151:8080/images/0000000.png"},      }
   ],
   "strengthsreferralSources":[ : 
"Good test taker",    {  
"abilityToBenefit" : true,       "anticipatedStartTermid" : "Fall"859ff107-1326-11e2-8698-406c8f22c3ce",
         "anticipatedStartYearname" :"Student "2012Conduct",
         "actualStartTermobjectStatus":"FallACTIVE",
      "actualStartYear":2012,},
      {  "studentIntakeRequestDate"
 : 1331269200000,       "specialServiceGroupsid" ::"858b0cab-1326-11e2-818e-406c8f22c3ce",
          [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
		   "name" : "Basketball Team",	
		"name":"HS Guidance Counselor",
         "objectStatus" : "ACTIVE"}
         ]},
      "referralSources"{ : 
         [{"id" : "a8c83fd4f6201a04-ee33bb31-46ee4ca5-8d89b606-9b2956696f37609f3ad09f87",
		         "name":"Faculty / :Staff "Counseling Services".
		Referral",
         "objectStatus" : "ACTIVE"},
         ]},
      "serviceReasons"{ : 
         [{"id" : "d95ea029ccadd634-90c1bd7a-4be011e1-b547-8054fc6914b7"},
		   "name" : "Developmental Education8d28-3368721922dc",
		   "objectStatus" : "ACTIVE"}    "name":"Ombudsman",
     ],       "confidentialityLevelsobjectStatus" :"ACTIVE"
null,      }
  "permissions" : null ],
   "serviceReasons":[  
"currentProgramStatusName" : "Active",    {  
"registeredForCurrentTerm" : true       "activeAlertsCountid":1"0a640a2a-409d-1271-8140-d0b3878000f6",
      "closedAlertsCount":2, 	  "residencyCountyname":"ButlerScholarship Recipient",
	   "f1Status":"Y", 	  "gender":"M", 	  "maritalStatusobjectStatus":"Single",
	  "ethnicity":null,"ACTIVE"
      "race":null},
	  "actionPlanTaskOpenCount":4, 	  "actionPlanTaskClosedCount":15,
	 {  "lastActionPlanCompletedDate":1367297284590
      "formattedStudentIntakeCompleteDate":null}   ] }

Returns

Person

Code Block
{"id" : "58ba5ee385709794-734e1326-4ae911e2-b9c58bab-943774b4de41406c8f22c3ce",
         "createdDatename" :"Academically 1331269200000Unprepared",
      "createdBy" :   "objectStatus":"ACTIVE"
      },
      {  
         "id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",
          "firstNamename" : "John"At-Risk Student",
          "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : 1331269200000,},
      {  "modifiedBy" :
         {"id" : "91f46e39205df6c0-cea8fea0-422b11e1-b2159678-00f6bcf5d280406c8f22c3ce",
          "firstNamename" :"Career "JohnCoaching",

         "lastNameobjectStatus" : "Doe"},ACTIVE"
      }
   ],
   "objectStatusconfidentialityLevels":null,
 :  "ACTIVEpermissions":null,

     "firstNamecurrentProgramStatusName" : "SallyActive",
  
   "middleNameprogramStatusChangeReasonName" : null,
  
   "lastNameregisteredForCurrentTerm" :false,
"Student",   "activeAlertsCount":2,
   "birthDateclosedAlertsCount" : "1983-08-20":1,
      "primaryEmailAddressresidencyCounty" : "sally.student@university.eduDemoCounty",
  
   "secondaryEmailAddressf1Status" : null"Y",
      "usernamegender" : "sally.studentM",
  
   "homePhonemaritalStatus" : "123-456-7890Separated",
  
   "workPhoneethnicity" : null,

     "cellPhonerace" : null,
   "actionPlanTaskOpenCount":1,
   "nonLocalAddressactionPlanTaskClosedCount" : null4,
 
    "addressLine1lastActionPlanCompletedDate" :1440076479537,
"444 West Third Street"confidentialityDisclosureAgreementSignedDate":1440076476617,
  
   "addressLine2homeCampus":{ : null,
      "cityid" : "Dayton"901e104b-4dc7-43f5-a38e-581015e204e1",
      "statename" :"North "OHCampus",
      "zipCodeobjectStatus" : "45402ACTIVE",
   },
   "alternateAddressLineInUseformattedCDACompleteDate" : null:"2015-08-20",
      "alternateAddressLine1formattedStudentIntakeCompleteDate" : 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
{  
   "alternateAddressLine2id" : null,
 :"d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
    "alternateAddressCitycreatedDate" : null1356998400000,
  
   "alternateAddressStatecreatedBy":{ : null,
      "alternateAddressZipCodeid" : null:"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "alternateAddressCountryfirstName" : null"Demo",
      "photoUrllastName" : null"Coach13",
      "schoolIdfullName" :"Demo null,Coach13"
      "enabled" : false,
  },
   "studentIntakeCompleteDatemodifiedDate" : null1444021202117,

     "studentTypemodifiedBy" :
{  
      {"id" : "ce0d041d58ba5ee3-d3ac734e-42a14ae9-9085b9c5-7f744240e07e943774b4de41",
 
        "namefirstName" : "Early Alert"
  System",
       "objectStatuslastName":"ACTIVEAdministrator"},},
      "coachfullName" :"System Administrator"
   },
    {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"ACTIVE",
          "firstName" : "AmyJames",
      "middleName":"Jacob",
   "lastName" : "AdvisorAnderson",
   "birthDate":"1986-10-24",
   "primaryEmailAddress":"demo@trainingssp.com",
   "primaryEmailAddresssecondaryEmailAddress" : "amy.advisor@university.edu:"",
   "username":"janderson218",
      "workPhonehomePhone" : "(123555) 456555-78905412",
   "workPhone":"",
   "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",
   "strengthsstate" : "Good test takerAZ",
      "abilityToBenefit" : true,"zipCode":"55555     ",
   "anticipatedStartTermalternateAddressInUse" : "Fall",
 false,
    "anticipatedStartYearalternateAddressLine1" : "2012",
      "actualStartTermalternateAddressLine2":"Fall",
  
   "actualStartYearalternateAddressCity":2012"",
      "studentIntakeRequestDate"alternateAddressState":" : 1331269200000",
      "specialServiceGroupsalternateAddressZipCode" :"           [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
		   "namealternateAddressCountry" : "Basketball Team",	
		   "objectStatusphotoUrl" : "ACTIVE"}
:null,
   "schoolId":"janderson218",
    ],"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 Campus"Active",
      "registeredForCurrentTermphotoUrl" :null
true   },
   "activeAlertsCountabilityToBenefit":1true,

     "closedAlertsCountanticipatedStartTerm":2"",
	   "residencyCountyanticipatedStartYear":"Butler"2011,
	   "f1StatusactualStartTerm":"YFA2011",
	   "genderactualStartYear":"M"2011,
	   "maritalStatusstudentIntakeRequestDate":"Single"1440076505197,
	   "ethnicityspecialServiceGroups":null,[  
      {  
"race":null, 	  "actionPlanTaskOpenCount":4, 	  "actionPlanTaskClosedCount":15, 	  "lastActionPlanCompletedDateid":1367297284590"856a3600-1326-11e2-9b79-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":"Student Athlete",
      "createdDate" : 1331269200000,   "objectStatus":"ACTIVE"
      },
      { "createdBy" :
         {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0c138a100fd",
          "name"firstName:"DEI :Focus "JohnGroup",

         "lastNameobjectStatus" : "DoeACTIVE"},
      }
 "modifiedDate" : 1331269200000],
  
   "modifiedByreferralSources" :[  
       {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", 
         "firstNameid" : "John:"859ff107-1326-11e2-8698-406c8f22c3ce",

         "lastNamename" :"Student Conduct"Doe"},
         "objectStatus" : "ACTIVE",
      },
"firstName" : "Sally",    {  
"middleName" : null,       "lastNameid" : "Student"858b0cab-1326-11e2-818e-406c8f22c3ce",
         "birthDatename":"HS :Guidance Counselor"1983-08-20",
         "primaryEmailAddressobjectStatus" : "sally.student@university.edu"ACTIVE"
      },
      {  
"secondaryEmailAddress" : null,       "usernameid" : "sally.student","f6201a04-bb31-4ca5-b606-609f3ad09f87",
         "name"homePhone:"Faculty / :Staff Referral"123-456-7890",,
         "workPhoneobjectStatus" :"ACTIVE"
null,      },
"cellPhone" : null,    {  
"nonLocalAddress" : null,       "addressLine1id" : "444 West Third Street",:"ccadd634-bd7a-11e1-8d28-3368721922dc",
         "name"addressLine2:"Ombudsman",
 : null,       "cityobjectStatus" : "DaytonACTIVE",
      "state" : "OH",}
   ],
   "zipCodeserviceReasons" : "45402",
  :[  
 "alternateAddressLineInUse" : null,    {  
"alternateAddressLine1" : null,       "alternateAddressLine2" : null,id":"0a640a2a-409d-1271-8140-d0b3878000f6",
         "alternateAddressCityname" :"Scholarship nullRecipient",
         "alternateAddressStateobjectStatus" :"ACTIVE"
null,      },
"alternateAddressZipCode" : null,    {  
"alternateAddressCountry" : null,       "photoUrl" : null,"id":"85709794-1326-11e2-8bab-406c8f22c3ce",
         "schoolIdname" :"Academically nullUnprepared",
         "enabledobjectStatus" :"ACTIVE"
false,      },
"studentIntakeCompleteDate" : null,    {  
"studentType" :          {"id" : "ce0d041df6201a04-d3acbb31-42a14ca5-9085b606-7f744240e07e609f3ad09f87",
          "name" : "EarlyAt-Risk AlertStudent"
,
         "objectStatus":"ACTIVE"
      },},
      { "coach" :
         {"id" : "91f46e39205df6c0-cea8fea0-422b11e1-b2159678-00f6bcf5d280406c8f22c3ce",

         "firstNamename" :"Career Coaching"Amy",

         "lastNameobjectStatus" : "AdvisorACTIVE",
      }
   "primaryEmailAddress" : "amy.advisor@university.edu"],
   "confidentialityLevels":null,
      "permissions":null,
   "workPhonecurrentProgramStatusName" : "(123) 456-7890"Active",
      "programStatusChangeReasonName":null,
   "officeLocationregisteredForCurrentTerm" :false,
"123 Benton Hall Room A""activeAlertsCount":2,
      "closedAlertsCount":1,
   "departmentNameresidencyCounty" : "DemoCounty"Engineering,
& Applied Science" 		  "photoUrlf1Status":"http://192.168.0.151:8080/images/0000000.png"}Y",
   "gender":"M",
   "strengthsmaritalStatus" : "Good test takerSeparated",
   "ethnicity":null,
   "abilityToBenefitrace" :null,
true,   "actionPlanTaskOpenCount":1,
   "anticipatedStartTermactionPlanTaskClosedCount" :4,
"Fall",   "lastActionPlanCompletedDate":1440076479537,
   "anticipatedStartYearconfidentialityDisclosureAgreementSignedDate" : "2012"1440076476617,

     "actualStartTermhomeCampus":"Fall",{  
      "actualStartYearid":2012"901e104b-4dc7-43f5-a38e-581015e204e1",
      "studentIntakeRequestDatename" :"North 1331269200000Campus",
      "specialServiceGroupsobjectStatus" :"ACTIVE"
     },
    [{"idformattedCDACompleteDate" : "437f6f2b2015-7b1e-47b4-8603-9e1208605c0d08-20",
		   "nameformattedStudentIntakeCompleteDate" : "Basketball Team",	
		:null
}

Returns

Person

Code Block
{  
   "objectStatusid" : "ACTIVE"}
    "d77f4697-ed36-4477-b8d0-67c9a1d8b2db",
    ]"createdDate":1356998400000,
      "referralSourcescreatedBy" :{  
        [{"id" : "a8c83fd422fc02f1-ee33d8b6-46ee496c-8d898e2d-9b2956696f3765f6973f888e",
   		   "namefirstName":"Demo",
: "Counseling Services". 		   "objectStatuslastName" : "ACTIVECoach13"},
      "fullName":"Demo Coach13"
 ]  },
   "modifiedDate":1444021202117,
   "serviceReasonsmodifiedBy" : 
{  
      [{"id" : "d95ea02958ba5ee3-90c1734e-4be04ae9-b547b9c5-8054fc6914b7943774b4de41"},
   		   "namefirstName" : "Developmental EducationSystem",
		      "objectStatuslastName" : "ACTIVEAdministrator"},
      "fullName":"System Administrator"
 ],   },
   "confidentialityLevelsobjectStatus" : null"ACTIVE",
    "firstName":"James",
   "permissionsmiddleName" :"Jacob",
null,   "lastName":"Anderson",
   "currentProgramStatusNamebirthDate" : "Active1986-10-24",
      "registeredForCurrentTermprimaryEmailAddress" :"demo@trainingssp.com",
true   "secondaryEmailAddress":"",
   "activeAlertsCountusername":1,
  "janderson218",
   "closedAlertsCounthomePhone":2,
	"(555) 555-5412",
   "residencyCountyworkPhone":"Butler",
	   "f1StatuscellPhone":"Y",
 	  "genderalternatePhone":"M212-555-1212",
	   "maritalStatusnonLocalAddress":"Single"false,
	   "ethnicityaddressLine1":null,"321 W. Demo St.",
   "raceaddressLine2":null"Apt. 214",
	   "actionPlanTaskOpenCountcity":4"Phoenix",
 	  "actionPlanTaskClosedCountstate":15"AZ",
 	  "lastActionPlanCompletedDatezipCode":1367297284590"55555     ",
   "formattedStudentIntakeCompleteDatealternateAddressInUse":null}false,
   ] }

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "alternateAddressLine1":"",
    "createdDatealternateAddressLine2" : 1331269200000,
  :"",
   "createdByalternateAddressCity" :"",
   "alternateAddressState":"  ",
   {"alternateAddressZipCode"id:" : "91f46e39-cea8-422b-b215-00f6bcf5d280",         ",
   "firstNamealternateAddressCountry" : "John",
   "photoUrl":null,
      "lastNameschoolId" : "Doejanderson218"},
   "enabled":true,
   "modifiedDatestudentIntakeCompleteDate" : 1331269200000null,
      "modifiedBystudentType" :{  
       {"id" : "91f46e390a640a2a-cea8409d-422b1271-b2158140-00f6bcf5d280d0af4a4200ef",
      "name":"Non-Degree Seeking",
      "firstNameobjectStatus" : "John",
 "ACTIVE"
    },
   "lastNamecoach" :{ "Doe"}, 
      "objectStatusid" : "ACTIVE"22fc02f1-d8b6-496c-8e2d-65f6973f888e",
      "firstName" : "SallyDemo",
      "middleNamelastName" : null"Coach13",
      "lastNameprimaryEmailAddress" : "Studentdemo@trainingssp.com",
      "birthDateworkPhone" : "1983-08-20"(777) 777-7777",
      "primaryEmailAddressofficeLocation" : "sally.student@university.edu":null,
      "secondaryEmailAddressdepartmentName" : null,
      "usernamehomeCampusName" :"West Campus"sally.student",
      "homePhonephotoUrl" : "123-456-7890",null
   },
   "workPhoneabilityToBenefit" :true,
null,   "anticipatedStartTerm":"",
   "cellPhoneanticipatedStartYear" : null2011,
   "actualStartTerm":"FA2011",
   "nonLocalAddressactualStartYear" :2011,
null,   "studentIntakeRequestDate":1440076505197,
   "addressLine1specialServiceGroups":[ : "444
West Third Street",    {  
"addressLine2" : null,       "cityid" : "Dayton","856a3600-1326-11e2-9b79-406c8f22c3ce",
         "statename" :"Student Athlete"OH",
         "zipCodeobjectStatus" : "45402ACTIVE",
      "alternateAddressLineInUse" : null,},
      {  
"alternateAddressLine1" : null,       "alternateAddressLine2" : null,"id":"0a640a2a-409d-1271-8140-d0c138a100fd",
         "name"alternateAddressCity:"DEI :Focus nullGroup",
      "alternateAddressState   "objectStatus":"ACTIVE"
: null,     }
 "alternateAddressZipCode" : null],
   "referralSources":[  
"alternateAddressCountry" : null,    {  
"photoUrl" : null,       "schoolId" : null,"id":"859ff107-1326-11e2-8698-406c8f22c3ce",
         "enabledname" :"Student falseConduct",
      "studentIntakeCompleteDate" : null,   "objectStatus":"ACTIVE"
      },
      { "studentType" :
         {"id" : "ce0d041d858b0cab-d3ac1326-42a111e2-9085818e-7f744240e07e406c8f22c3ce",
          "name" :"HS "EarlyGuidance AlertCounselor",
          "objectStatus":"ACTIVE"
      },},
      { "coach" :
         {"id" : "91f46e39f6201a04-cea8bb31-422b4ca5-b215b606-00f6bcf5d280609f3ad09f87",
          "firstNamename" : "Amy",Faculty /          "lastName" : "Advisor",
Staff Referral",
         "primaryEmailAddressobjectStatus" : "amy.advisor@university.eduACTIVE",
      },
   "workPhone"  : "(123) 456-7890",{  
         "officeLocationid" : "123 Benton Hall Room A"ccadd634-bd7a-11e1-8d28-3368721922dc",
          "departmentName" : "Engineering & Applied Science"
		  "photoUrl":"http://192.168.0.151:8080/images/0000000.png"},"name":"Ombudsman",
         "objectStatus":"ACTIVE"
      }
"strengths" : "Good test taker" ],
   "serviceReasons":[  
"abilityToBenefit" : true,    {  
"anticipatedStartTerm" : "Fall",       "anticipatedStartYearid" : "2012"0a640a2a-409d-1271-8140-d0b3878000f6",
         "actualStartTermname":"FallScholarship Recipient",
         "actualStartYearobjectStatus":2012,"ACTIVE"
      "studentIntakeRequestDate" : 1331269200000},
      "specialServiceGroups"{ : 
         [{"id" : "437f6f2b85709794-7b1e1326-47b411e2-86038bab-9e1208605c0d406c8f22c3ce",
		
         "name" : "BasketballAcademically TeamUnprepared",	
		
         "objectStatus" : "ACTIVE"}
         ]},
      "referralSources"{ : 
         [{"id" : "a8c83fd4f6201a04-ee33bb31-46ee4ca5-8d89b606-9b2956696f37609f3ad09f87",
		         "name" :"At-Risk "Counseling Services".
		Student",
         "objectStatus" : "ACTIVE"},
         ]},
      "serviceReasons"{ : 
         [{"id" : "d95ea029205df6c0-90c1fea0-4be011e1-b5479678-8054fc6914b7406c8f22c3ce"},
		
         "name" : "DevelopmentalCareer EducationCoaching",
		
         "objectStatus" : "ACTIVE"}
      }
   ],
   "confidentialityLevels":null,
   "confidentialityLevelspermissions" : null,
   "currentProgramStatusName":"Active",
    "permissionsprogramStatusChangeReasonName" : null,
   "registeredForCurrentTerm":false,
   "currentProgramStatusNameactiveAlertsCount":2,
   "closedAlertsCount":1,
   "ActiveresidencyCounty":"DemoCounty",
   "f1Status":"Y",
   "registeredForCurrentTermgender" :"M",
true   "maritalStatus":"Separated",
   "activeAlertsCountethnicity":1null,
  
   "closedAlertsCountrace":2null,
	   "residencyCountyactionPlanTaskOpenCount":"Butler"1,
	   "f1StatusactionPlanTaskClosedCount":"Y"4,
	   "genderlastActionPlanCompletedDate":"M"1440076479537,
 	  "maritalStatusconfidentialityDisclosureAgreementSignedDate":"Single"1440076476617,
	   "ethnicityhomeCampus":null,{  
      "raceid":null"901e104b-4dc7-43f5-a38e-581015e204e1",
       "actionPlanTaskOpenCountname":4"North Campus",
	   "actionPlanTaskClosedCount":15, 	  "lastActionPlanCompletedDateobjectStatus":1367297284590"ACTIVE"
   },
   "formattedStudentIntakeCompleteDateformattedCDACompleteDate":null}"2015-08-20",
   ]
} "formattedStudentIntakeCompleteDate":n

 

Delete a Person

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

...