Page Comparison

...

The programStatus that is returned is the currently assigned program status. Use the Person Program Status API to select all program statuses for the person.

Get All Persons

GET /ssp/api/1/person

Security

PERSON_READ

Parameters

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

Returns

...

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

Get All Persons

GET /ssp/api/1/person

Security

PERSON_READ

Parameters

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

Returns

Code Block

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "modifiedDatecreatedDate" : 1331269200000,
      "modifiedBycreatedBy" :
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"}, 
      "objectStatusmodifiedDate" : "ACTIVE"1331269200000,
      "firstNamemodifiedBy" :
  "Sally",       {"middleInitialid" : null,"91f46e39-cea8-422b-b215-00f6bcf5d280",
          "lastNamefirstName" : "StudentJohn",
          "birthDatelastName" : null"Doe"}, 
      "primaryEmailAddressobjectStatus" : "sally.student@university.eduACTIVE",
      "secondaryEmailAddressfirstName" : null"Sally",
      "usernamemiddleInitial" : "sally.student"null,
      "homePhonelastName" : "123-456-7890Student",
      "workPhonebirthDate" : null,
      "cellPhoneprimaryEmailAddress" : null"sally.student@university.edu",
      "nonLocalAddresssecondaryEmailAddress" : null,
      "username" : "sally.student",
      "homePhone" : "123-456-7890",
      "workPhone" : null,
      "cellPhone" : null,
      "nonLocalAddress" : null,
      "addressLine1" : "444 West Third Street",
      "addressLine2" : null,
      "city" : "Dayton",
      "state" : "OH",
      "zipCode" : "45402",
      "alternateAddressLineInUse" : null,
      "alternateAddressLine1" : null,
      "alternateAddressLine2" : null,
      "alternateAddressCity" : null,
      "alternateAddressState" : null,
      "alternateAddressZipCode" : null,
      "alternateAddressCountry" : null,
      "photoUrl" : null,
      "schoolId" : null,
      "enabled" : false,
      "studentIntakeCompleteDate" : null,
      "studentType: null,
      "photoUrl" : null,
      "schoolId" : null,
      "enabled" : false,
      "studentIntakeCompleteDate" : null,
      "studentType" :
         {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
          "name" : "Early Alert"},
      "coach" :
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "Amy",
          "lastName" : "Advisor",
          "primaryEmailAddress" : "amy.advisor@university.edu",
          "workPhone" : "(123) 456-7890",
          "officeLocation" : "123 Benton Hall Room A",
          "departmentName" : "Engineering & Applied Science"}, 
      "strengths" : "Good test taker",
      "abilityToBenefit" : true,
      "anticipatedStartTerm" : "Fall",
      "anticipatedStartYear" : "2012",
      "studentIntakeRequestDate" : 1331269200000,
      "specialServiceGroupIds" : 
         [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
		   "name" : "Basketball Team",	
		   "objectStatus" : "ACTIVE"}
         ],
      "referralSourceIds" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
		   "name" : "Counseling Services".
		   "objectStatus" : "ACTIVE"},
         ],
      "serviceReasonIds" : 
         [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		   "name" : "Developmental Education",
		   "objectStatus" : "ACTIVE"}
         ],
      "confidentialityLevels" : null,  
      "permissions" : null,
      "currentProgramStatusName" : "Active",
      "registeredForCurrentTerm" : true}
    ]
}

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" : "ce0d041d58ba5ee3-d3ac734e-42a14ae9-9085b9c5-7f744240e07e943774b4de41",

         "namefirstName" : "Early AlertCamden"},
      "coachlastName" : "Coach"},
        {"id" : "91f46e3963d62297-cea8bf08-422b496f-b215acf3-00f6bcf5d2800c129d437c2b",
   
      "firstName" : "AmyChristina",
   
      "lastName" : "AdvisorCoach"},
      ...
    "primaryEmailAddress]
}

Get a Person

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

Security

PERSON_READ

Returns

Person

Code Block

{"id" : "amy.advisor@university.edu58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
    {"workPhoneid" : "(123) 456-7890",
  91f46e39-cea8-422b-b215-00f6bcf5d280",
       "officeLocationfirstName" : "123 Benton Hall Room AJohn",
     "lastName" : "Doe"}, 
 "departmentNamemodifiedDate" : "Engineering1331269200000,
& Applied Science"}, "modifiedBy" :
      {"strengthsid" : "Good test taker91f46e39-cea8-422b-b215-00f6bcf5d280",

     "abilityToBenefitfirstName" : true"John",

     "anticipatedStartTermlastName" : "FallDoe"}, 
 "objectStatus" : "ACTIVE",
 "anticipatedStartYearfirstName" : "2012Sally",
 "middleInitial" : null,
  "studentIntakeRequestDatelastName" : 1331269200000"Student",
 "birthDate" : null,
  "specialServiceGroupIdsprimaryEmailAddress" : 
 "sally.student@university.edu",
 "secondaryEmailAddress" :  null,
   [{"idusername" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
          {"idsally.student",
 "homePhone" : "7bf36968123-ad48-4c5f-9838-ebf495713c08"}456-7890",
 "workPhone" : null,
 "cellPhone" : null,
  ...
         ],
      "referralSourceIds" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
          {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
          ...
         ],
      "serviceReasonIds" : 
         ["nonLocalAddress" : null,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "alternateAddressLineInUse" : null,
 "alternateAddressLine1" : null,
 "alternateAddressLine2" : null,
 "alternateAddressCity" : null,
 "alternateAddressState" : null,
 "alternateAddressZipCode" : null,
 "alternateAddressCountry" : null,
 "photoUrl" : null,
 "schoolId" : null,
 "enabled" : false,
 "studentIntakeCompleteDate" : null,
 "coach" :
    {"id" : "d95ea02991f46e39-90c1cea8-4be0422b-b547b215-8054fc6914b700f6bcf5d280"},
     "firstName" : "Amy",
   {  "idlastName" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"}Advisor",
     "primaryEmailAddress" :    "amy.advisor@university..edu",
     "workPhone" :   ]"(123) 456-7890",
      "confidentialityLevelsofficeLocation" : null,"123 Benton Hall Room A",
     "permissionsdepartmentName" : null,"Engineering & Applied     "currentProgramStatusName" :Science"},
 "Activestrengths", : "Good test taker",
  "registeredForCurrentTermabilityToBenefit" : true},
 "anticipatedStartTerm"   ]
}

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: "Fall",
 "anticipatedStartYear" : "2012",
 "studentType" :
    {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
     "name" : "Early Alert"},
 "studentIntakeRequestDate" : 1331269200000,
 "specialServiceGroupIds" : 
    [{"id" : "58ba5ee3437f6f2b-734e7b1e-4ae947b4-b9c58603-943774b4de419e1208605c0d",
	       "firstNamename" : "CamdenBasketball Team",	
  		    "lastNameobjectStatus" : "CoachACTIVE"}
         ],
 "referralSourceIds" : 
         [{"id" : "63d62297a8c83fd4-bf08ee33-496f46ee-acf38d89-0c129d437c2b9b2956696f37",
		   "name" : "Counseling Services".
		   "firstNameobjectStatus" : "ChristinaACTIVE"},
         "lastName"],
: "CoachserviceReasonIds"}, : 
    ...     ]
}

Get a Person

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

Security

PERSON_READ

Returns

Person

Code Block

{[{"id" : "58ba5ee3d95ea029-734e90c1-4ae94be0-b9c5-943774b4de41",
 "createdDate" : 1331269200000b547-8054fc6914b7"},
		   "name" : "Developmental Education",
		   "objectStatus" : "ACTIVE"}
         ],
 "createdByconfidentialityLevels" : null,  
 {"idpermissions" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 null,
   "firstNamecurrentProgramStatusName" : "JohnActive",
 "registeredForCurrentTerm" :    "lastName" : "Doe"}, 
 "modifiedDate" : 1331269200000,
 "modifiedBy" :
    true
}

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" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastNameb9c5-943774b4de41",
 "createdDate" : "Doe"}1331269200000, 
 "objectStatuscreatedBy" :
"ACTIVE",    {"firstNameid" : "Sally91f46e39-cea8-422b-b215-00f6bcf5d280",
 "middleInitial" : null,  "lastNamefirstName" : "StudentJohn",
 "birthDate" : null,  "primaryEmailAddresslastName" : "sally.student@university.eduDoe"}, 
 "secondaryEmailAddressmodifiedDate" : null1331269200000,
 "usernamemodifiedBy" :
"sally.student",    {"homePhoneid" : "123-456-789091f46e39-cea8-422b-b215-00f6bcf5d280",
 "workPhone" : null,  "cellPhonefirstName" : null"John",
 "nonLocalAddress" : null,  "addressLine1lastName" : "444 West Third Street",Doe"}, 
 "addressLine2objectStatus" : null"ACTIVE",
 "cityfirstName" : "DaytonSally",
 "statemiddleInitial" : "OH"null,
 "zipCodelastName" : "45402Student",
 "alternateAddressLineInUsebirthDate" : null,
 "alternateAddressLine1primaryEmailAddress" : null"sally.student@university.edu",
 "alternateAddressLine2secondaryEmailAddress" : null,
 "alternateAddressCityusername" : null"sally.student",
 "alternateAddressStatehomePhone" : null"123-456-7890",
 "alternateAddressZipCodeworkPhone" : null,
 "alternateAddressCountrycellPhone" : null,
 "photoUrlnonLocalAddress" : null,
 "schoolIdaddressLine1" : null"444 West Third Street",
 "enabledaddressLine2" : falsenull,
 "studentIntakeCompleteDatecity" : null"Dayton",
 "coachstate" : "OH",
   {"idzipCode" : "91f46e39-cea8-422b-b215-00f6bcf5d28045402",
 "alternateAddressLineInUse" : null,
 "firstNamealternateAddressLine1" : "Amy"null,
 "alternateAddressLine2" : null,
 "lastNamealternateAddressCity" : "Advisor"null,
 "alternateAddressState" : null,
 "primaryEmailAddressalternateAddressZipCode" : "amy.advisor@university.edu"null,
     "workPhonealternateAddressCountry" : null,
 "(123) 456-7890"photoUrl" : null,
 "schoolId" : null,
 "officeLocationstudentIntakeCompleteDate" : "123 Benton Hall Room A",
null,
 "enabled" : false,
 "coach" :
    {"departmentNameid" : "Engineering & Applied Science"},91f46e39-cea8-422b-b215-00f6bcf5d280",
     "strengthsfirstName" : "Good test takerAmy",
 "abilityToBenefit" : true,  "anticipatedStartTermlastName" : "FallAdvisor",
     "anticipatedStartYearprimaryEmailAddress" : "2012amy.advisor@university.edu",
 "studentType" :     {"idworkPhone" : "ce0d041d-d3ac-42a1-9085-7f744240e07e(123) 456-7890",
     "nameofficeLocation" : "Early Alert"}123 Benton Hall Room A",
 "studentIntakeRequestDate" : 1331269200000,  "specialServiceGroupIdsdepartmentName" : "Engineering & Applied Science"},
 [{"idstrengths" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}Good test taker",
 "abilityToBenefit" : true,
 {"idanticipatedStartTerm" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
     ...
    ]Fall",
 "anticipatedStartYear" : "2012",
 "referralSourceIdsstudentType" :
     [{"id" : "a8c83fd4ce0d041d-ee33d3ac-46ee42a1-8d899085-9b2956696f377f744240e07e"},
     {"idname" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7Early Alert"},
 "studentIntakeRequestDate"    ...
    ]: 1331269200000,
 "serviceReasonIdsspecialServiceGroupIds" : 
    [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},      [{"id" : "c9ff0ce6437f6f2b-aec67b1e-4be247b4-b1d18603-9ca385edc6379e1208605c0d"},

    ...     ],  "confidentialityLevelsname" : "Basketball nullTeam",    
 "permissions" : null,          "currentProgramStatusNameobjectStatus" : "Active",ACTIVE"}
      "registeredForCurrentTerm" : true
}

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

{ ],
 "referralSourceIds" : 
         [{"id" : "58ba5ee3a8c83fd4-734eee33-4ae946ee-b9c5-943774b4de41",
 "createdDate" : 13312692000008d89-9b2956696f37",
           "name" : "Counseling Services".
           "objectStatus" : "ACTIVE"},
         ],
 "createdByserviceReasonIds" : 
         [{"id" : "91f46e39d95ea029-cea890c1-422b4be0-b215b547-00f6bcf5d2808054fc6914b7"},
           "firstNamename" : "JohnDevelopmental Education",
           "lastNameobjectStatus" : "DoeACTIVE"},
  "modifiedDate" : 1331269200000,  "modifiedBy" :   ],
 {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 confidentialityLevels" : null,  
 "firstNamepermissions" : "John"null,

    "lastNamecurrentProgramStatusName" : "DoeActive"},
  "objectStatusregisteredForCurrentTerm" : "ACTIVE",
 true
}

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",
 "middleInitial" : null,
 "lastName" : "Student",
 "birthDate" : null,
 "primaryEmailAddress" : "sally.student@university.edu",
 "secondaryEmailAddress" : null,
 "username" : "sally.student",
 "homePhone" : "123-456-7890",
 "workPhone" : null,
 "cellPhone" : null,
 "nonLocalAddress" : null,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "alternateAddressLineInUse" : null,
 "alternateAddressLine1" : null,
 "alternateAddressLine2" : null,
 "alternateAddressCity" : null,
 "alternateAddressState" : null,
 "alternateAddressZipCode" : null,
 "alternateAddressCountry" : null,
  "photoUrl" : null,
 "schoolId" : null,
 "studentIntakeCompleteDateenabled" : nullfalse,
 "enabledstudentIntakeCompleteDate" : falsenull,
 "coach" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "Amy",
     "lastName" : "Advisor",
     "primaryEmailAddress" : "amy.advisor@university.edu",
     "workPhone" : "(123) 456-7890",
     "officeLocation" : "123 Benton Hall Room A",
     "departmentName" : "Engineering & Applied Science"},
 "strengths" : "Good test taker",
 "abilityToBenefit" : true,
 "anticipatedStartTerm" : "Fall",
 "anticipatedStartYear" : "2012",
 "studentType" :
    {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
     "name" : "Early Alert"},
 "studentIntakeRequestDate" : 1331269200000,
 "specialServiceGroupIds" : 
    [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
     {"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
     ...
    ],
 "referralSourceIdsstudentIntakeRequestDate" : 1331269200000,
 "specialServiceGroupIds" : 
 [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},      [{"id" : "55aebdf7437f6f2b-466b7b1e-49c447b4-a08c8603-6e01eaf101d79e1208605c0d"},
     ...      ],"name" : "serviceReasonIdsBasketball Team", :   
   [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},      {"idobjectStatus" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637ACTIVE"},

    ...     ],
 "confidentialityLevelsreferralSourceIds" : 
null,     "permissions" : null,  [{"currentProgramStatusNameid" : "Activea8c83fd4-ee33-46ee-8d89-9b2956696f37",
    "registeredForCurrentTerm" : true
}

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       "name" : "Counseling Services".
           "objectStatus" : "SallyACTIVE"},
  "middleInitial       ],
 "serviceReasonIds" : null, 
         [{"lastNameid" : "Student",
 "birthDate" : null,
 "primaryEmailAddressd95ea029-90c1-4be0-b547-8054fc6914b7"},
           "name" : "sally.student@university.eduDevelopmental Education",
   "secondaryEmailAddress" : null,        "usernameobjectStatus" : "sally.student",ACTIVE"}
   "homePhone" : "123-456-7890",  "workPhone" : null],
 "cellPhoneconfidentialityLevels" : null,  
 "nonLocalAddresspermissions" : null,
 "addressLine1currentProgramStatusName" : "444Active",
West Third Street"registeredForCurrentTerm", : "addressLine2null
}

Returns

Person

Code Block

{"id" : null"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "citycreatedDate" : "Dayton"1331269200000,
 "statecreatedBy" :
"OH",    {"zipCodeid" : "4540291f46e39-cea8-422b-b215-00f6bcf5d280",
 "alternateAddressLineInUse" : null,  "alternateAddressLine1firstName" : null"John",
 "alternateAddressLine2" : null,  "alternateAddressCitylastName" : null"Doe"}, 
 "alternateAddressStatemodifiedDate" : null1331269200000,
 "alternateAddressZipCodemodifiedBy" :
null,  "alternateAddressCountry" : null,
 "photoUrl{"id" : null,
 "schoolId" : null"91f46e39-cea8-422b-b215-00f6bcf5d280",
 "enabled" : false,  "studentIntakeCompleteDatefirstName" : null,
 "coachJohn",
:     {"idlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Doe"}, 
 "objectStatus" : "ACTIVE",
 "firstName" : "AmySally",
 "middleInitial" : null,
 "lastName" : "AdvisorStudent",
 "birthDate" : null,
 "primaryEmailAddress" : "amysally.advisor@universitystudent@university.edu",
 "secondaryEmailAddress" : null,
 "workPhoneusername" : "(123) 456-7890sally.student",
  
  "officeLocationhomePhone" : "123 Benton Hall Room A" "123-456-7890",
 "workPhone" : null,
 "cellPhone" : null,
 "departmentNameaddressLine1" : "Engineering444 &West AppliedThird ScienceStreet"},
 "strengthsaddressLine2" : "Good test taker"null,
 "abilityToBenefitcity" : true"Dayton",
 "anticipatedStartTermstate" : "FallOH",
 "anticipatedStartYearzipCode" : "201245402",
 "studentTypenonLocalAddress" : null,
   {"idalternateAddressLineInUse" : "ce0d041d-d3ac-42a1-9085-7f744240e07e"null,
 "alternateAddressLine1" : null,
 "namealternateAddressLine2" : "Early Alert"}null,
 "studentIntakeRequestDatealternateAddressCity" : 1331269200000null,
 "specialServiceGroupIdsalternateAddressState" : 
  null,
 [{"idalternateAddressZipCode" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}null,
 "alternateAddressCountry" : null,
 {"idphotoUrl" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}null,
 "schoolId"    ...
    ]: null,
 "referralSourceIdsenabled" : false,
    [{"idstudentIntakeCompleteDate" : null,
 "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
coach" :
    {"id" : "55aebdf791f46e39-466bcea8-49c4422b-a08cb215-6e01eaf101d700f6bcf5d280"},
     ...
 "firstName" : "Amy",
   ],  "serviceReasonIdslastName" : "Advisor",
     [{"idprimaryEmailAddress" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}amy.advisor@university.edu",
     {"idworkPhone" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"}(123) 456-7890",
     ...
    ],
 "confidentialityLevels" : null,"officeLocation" : "123 Benton Hall Room A",
     "permissionsdepartmentName" : null "Engineering & Applied Science"},
 "currentProgramStatusNamestrengths" : "ActiveGood test taker",
 "registeredForCurrentTermabilityToBenefit" : true,
null }

Returns

Person

Code Block

{"id"anticipatedStartTerm" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41Fall",
 "createdDateanticipatedStartYear" : 1331269200000"2012",
 "createdBystudentType" :
    {"id" : "91f46e39ce0d041d-cea8d3ac-422b42a1-b2159085-00f6bcf5d2807f744240e07e",
     "firstNamename" : "JohnEarly Alert"},
     "lastNamestudentIntakeRequestDate" : "Doe"}1331269200000,
  "modifiedDatespecialServiceGroupIds" : 
 1331269200000,  "modifiedBy" :     [{"id" : "91f46e39437f6f2b-cea87b1e-422b47b4-b2158603-00f6bcf5d2809e1208605c0d",
           "firstNamename" : "JohnBasketball Team",    
     "lastName"  : "Doe"},   "objectStatus" : "ACTIVE"}
         ],
 "firstNamereferralSourceIds" : "Sally",
     "middleInitial" : null,  [{"lastNameid" : "Studenta8c83fd4-ee33-46ee-8d89-9b2956696f37",
       "birthDate" : null,  "primaryEmailAddressname" : "Counseling Services"sally.student@university.edu",
 "secondaryEmailAddress" : null,  "username" : "sally.student",  "homePhone" : "123-456-7890objectStatus", : "workPhone" : nullACTIVE"},
 "cellPhone" : null,  "addressLine1" : "444 West Third Street"],
 "addressLine2serviceReasonIds" : null,
 "city" : "Dayton",  "state" : "OH",   [{"zipCodeid" : "45402",
 "nonLocalAddress" : null,
 "alternateAddressLineInUse" : null,
 "alternateAddressLine1" : null,
 "alternateAddressLine2" : null,
 "alternateAddressCity" : null,
 "alternateAddressState" : null,
 "alternateAddressZipCode" : null,
 "alternateAddressCountry" : null,
 "photoUrl" : null,
 "schoolId" : null,
 "enabled" : false,
 "studentIntakeCompleteDated95ea029-90c1-4be0-b547-8054fc6914b7"},
           "name" : "Developmental Education",
           "objectStatus" : "ACTIVE"}
         ],
 "confidentialityLevels" : null,  
 "coachpermissions" :   null,
 {"idcurrentProgramStatusName" : "91f46e39-cea8-422b-b215-00f6bcf5d280Active",
 "registeredForCurrentTerm" :   "firstNametrue
}

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" : "Amy58ba5ee3-734e-4ae9-b9c5-943774b4de41",
     "lastNamecreatedDate" : "Advisor",
   1331269200000,
 "primaryEmailAddresscreatedBy" :
"amy.advisor@university.edu",      {"workPhoneid" : "(123) 456-789091f46e39-cea8-422b-b215-00f6bcf5d280",

    "officeLocation" : "123 Benton Hall Room A",
     "departmentName" : "Engineering & Applied Science"},  "strengthsfirstName" : "Good test takerJohn",
 "abilityToBenefit" : true,  "anticipatedStartTermlastName" : "FallDoe"}, 
 "anticipatedStartYearmodifiedDate" : "2012"1331269200000,
 "studentTypemodifiedBy" :
    {"id" : "ce0d041d91f46e39-d3accea8-42a1422b-9085b215-7f744240e07e00f6bcf5d280",
     "namefirstName" : "Early AlertJohn"},
     "studentIntakeRequestDatelastName" : 1331269200000"Doe"}, 
 "specialServiceGroupIdsobjectStatus" : 
  "ACTIVE",
 [{"idfirstName" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}Sally",
 "middleInitial" : null,
  {"idlastName" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
     ...
    ]Student",
 "birthDate" : null,
 "primaryEmailAddress" : "sally.student@university.edu",
 "secondaryEmailAddress" : null,
 "referralSourceIdsusername" : 
  "sally.student",
 [{"idhomePhone" : "a8c83fd4123-ee33-46ee-8d89-9b2956696f37"}456-7890",
 "workPhone" : null,
 {"idcellPhone" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"} null,
 "nonLocalAddress" : null,
 ...
    ]"addressLine1" : "444 West Third Street",
 "serviceReasonIdsaddressLine2" : null,
 "city" :  [{"id"Dayton",
 "state" : "d95ea029-90c1-4be0-b547-8054fc6914b7"}OH",
 "zipCode" : "45402",
 {"idalternateAddressLineInUse" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
     ...
    ]null,
 "alternateAddressLine1" : null,
 "alternateAddressLine2" : null,
 "alternateAddressCity" : null,
 "confidentialityLevelsalternateAddressState" : null, 
  "permissionsalternateAddressZipCode" : null,
 "currentProgramStatusNamealternateAddressCountry" : "Active"null,
 "registeredForCurrentTermphotoUrl" : null,
true }

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",
 "createdDate" : 1331269200000,
 "createdBy"schoolId" : null,
 "enabled" : false,
 "studentIntakeCompleteDate" : null,
 "coach" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "JohnAmy",
     "lastName" : "DoeAdvisor"},
  "modifiedDate" : 1331269200000,
 "modifiedByprimaryEmailAddress" :     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280""amy.advisor@university.edu",
     "firstNameworkPhone" : "John(123) 456-7890",
     "lastName" : "Doe"}, 
 "objectStatusofficeLocation" : "ACTIVE",123 Benton "firstName"Hall :Room A"Sally",
 "middleInitial" : null,  "lastNamedepartmentName" : "Student"Engineering & Applied Science"},
 "birthDatestrengths" : null,
 "primaryEmailAddress" : "sally.student@university.edu""Good test taker",
 "secondaryEmailAddressabilityToBenefit" : nulltrue,
 "usernameanticipatedStartTerm" : "sally.studentFall",
 "homePhoneanticipatedStartYear" : "123-456-78902012",
 "workPhonestudentType" :
null,    {"cellPhoneid" : null"ce0d041d-d3ac-42a1-9085-7f744240e07e",
 "nonLocalAddress" : null,  "addressLine1name" : "444 West Third Street"Early Alert"},
 "addressLine2studentIntakeRequestDate" : null1331269200000,
 "cityspecialServiceGroupIds" : "Dayton", 
     "state" : "OH",  [{"zipCodeid" : "45402437f6f2b-7b1e-47b4-8603-9e1208605c0d",
   "alternateAddressLineInUse" : null,  "alternateAddressLine1" : null,  "alternateAddressLine2name" : null"Basketball Team",   "alternateAddressCity" 
: null,  "alternateAddressState" : null,  "alternateAddressZipCode" : null,  "alternateAddressCountryobjectStatus" : null,
 "photoUrlACTIVE"}
: null,  "schoolId" : null,  "enabled" : false],
 "studentIntakeCompleteDatereferralSourceIds" : 
 null,  "coach" :     [{"id" : "91f46e39a8c83fd4-cea8ee33-422b46ee-b2158d89-00f6bcf5d2809b2956696f37",
     "firstName      "name" : "AmyCounseling Services",.
     "lastName" : "Advisor",      "primaryEmailAddressobjectStatus" : "amy.advisor@university.eduACTIVE"},
 
   "workPhone" : "(123) 456-7890",       ],
 "officeLocationserviceReasonIds" : "123
Benton Hall Room A",      [{"departmentNameid" : "Engineering & Applied Scienced95ea029-90c1-4be0-b547-8054fc6914b7"},
 "strengths" : "Good test taker",  "abilityToBenefit" : true,  "anticipatedStartTermname" : "FallDevelopmental Education",
 "anticipatedStartYear" : "2012",  "studentType" :     {"idobjectStatus" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",ACTIVE"}
      "name" : "Early Alert"}],
 "studentIntakeRequestDateconfidentialityLevels" : 1331269200000null,  
 "specialServiceGroupIdspermissions" : null,
    [{"idcurrentProgramStatusName" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}Active",
 "registrationStatusForCurrentTerm" :   true
}

Returns

Person

Code Block

{"id" : "7bf3696858ba5ee3-ad48734e-4c5f4ae9-9838b9c5-ebf495713c08943774b4de41"},
 "createdDate"    ...
    ]: 1331269200000,
 "referralSourceIdscreatedBy" :
     [{"id" : "a8c83fd491f46e39-ee33cea8-46ee422b-8d89b215-9b2956696f3700f6bcf5d280"},
     {"idfirstName" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},John",
      ..."lastName" : "Doe"}, 
 "modifiedDate" : ]1331269200000,
 "serviceReasonIdsmodifiedBy" :
     [{"id" : "d95ea02991f46e39-90c1cea8-4be0422b-b547b215-8054fc6914b700f6bcf5d280"},
     {"idfirstName" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"}John",
     ..."lastName" : "Doe"}, 
 "objectStatus" : ]"ACTIVE",
 "confidentialityLevelsfirstName" : null"Sally", 
  "permissionsmiddleInitial" : null,
 "currentProgramStatusNamelastName" : "ActiveStudent",
 "registrationStatusForCurrentTermbirthDate" : true
}

Returns

Person

Code Block

{"idnull,
 "primaryEmailAddress" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41sally.student@university.edu",
 "createdDatesecondaryEmailAddress" : 1331269200000null,
 "createdByusername" :     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280""sally.student",
     "firstNamehomePhone" : "John123-456-7890",
   
 "lastNameworkPhone" : "Doe"}null, 
 "modifiedDatecellPhone" : 1331269200000null,
 "modifiedBynonLocalAddress" :  null,
  {"idaddressLine1" : "91f46e39-cea8-422b-b215-00f6bcf5d280444 West Third Street",
 "addressLine2" : null,
 "firstNamecity" : "JohnDayton",
     "lastNamestate" : "DoeOH"}, 
 "objectStatuszipCode" : "ACTIVE45402",
 "firstNamealternateAddressLineInUse" : "Sally"null,
 "middleInitialalternateAddressLine1" : null,
 "lastNamealternateAddressLine2" : "Student"null,
 "birthDatealternateAddressCity" : null,
 "primaryEmailAddressalternateAddressState" : "sally.student@university.edu"null,
 "secondaryEmailAddressalternateAddressZipCode" : null,
 "usernamealternateAddressCountry" : "sally.student"null,
 "homePhonephotoUrl" : "123-456-7890"null,
 "workPhoneschoolId" : null,
 "cellPhonestudentIntakeCompleteDate" : null,
 "nonLocalAddressenabled" : nullfalse,
 "addressLine1coach" :
"444  West Third Street{"id", : "addressLine2" : null,91f46e39-cea8-422b-b215-00f6bcf5d280",
     "cityfirstName" : "DaytonAmy",
     "statelastName" : "OHAdvisor",
     "zipCodeprimaryEmailAddress" : "45402amy.advisor@university.edu",
     "alternateAddressLineInUseworkPhone" : null "(123) 456-7890",
 "alternateAddressLine1" : null,  "alternateAddressLine2officeLocation" : null,"123 Benton "alternateAddressCity"Hall :Room nullA",
 "alternateAddressState" : null,  "alternateAddressZipCodedepartmentName" : null "Engineering & Applied Science"},
 "alternateAddressCountrystrengths" : null,"Good test taker"photoUrl" : null,
 "schoolIdabilityToBenefit" : nulltrue,
 "studentIntakeCompleteDateanticipatedStartTerm" : null"Fall",
 "enabledanticipatedStartYear" : false"2012",
 "coachstudentType" :
    {"id" : "91f46e39ce0d041d-cea8d3ac-422b42a1-b215-00f6bcf5d280",
     "firstName" : "Amy9085-7f744240e07e",
     "lastNamename" : "AdvisorEarly Alert"},
 "studentIntakeRequestDate" : 1331269200000,
 "primaryEmailAddressspecialServiceGroupIds" : "amy.advisor@university.edu",
         [{"workPhoneid" : "(123) 456-7890",437f6f2b-7b1e-47b4-8603-9e1208605c0d",
           "officeLocationname" : "123Basketball BentonTeam", Hall Room A", 
    "departmentName" : "Engineering & Applied Science"},  "strengthsobjectStatus" : "ACTIVE"Good}
test taker",  "abilityToBenefit" : true,  "anticipatedStartTerm" : "Fall"],
 "anticipatedStartYearreferralSourceIds" : 
 "2012",  "studentType" :     [{"id" : "ce0d041da8c83fd4-d3acee33-42a146ee-90858d89-7f744240e07e9b2956696f37",
     "name"  : "Early Alert"},  "studentIntakeRequestDatename" : 1331269200000,"Counseling  Services"specialServiceGroupIds".
:      [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
     {"idobjectStatus" : "7bf36968-ad48-4c5f-9838-ebf495713c08ACTIVE"},

    ...     ],
 "referralSourceIdsserviceReasonIds" :  
   [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},      [{"id" : "55aebdf7d95ea029-466b90c1-49c44be0-a08cb547-6e01eaf101d78054fc6914b7"},
     ...     ],  "serviceReasonIdsname" : "Developmental Education",
   [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},      {"idobjectStatus" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637ACTIVE"},
     ...     ],
 "confidentialityLevels" : null,  
 "permissions" : null,
 "currentProgramStatusName" : "Active",
 "registeredForCurrentTerm" : true
}

...

Versions Compared

Old Version 45

New Version 46

Key

Get All Persons

Get All Persons

Get All Persons Who Are Coaches

Get a Person

Get All Persons Who Are Coaches

Get a Person

Get a Person by School ID

Get a Person by School ID

Create a Person

Create a Person

Save a Person

Save a Person