Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 39 Next »

Overview

Methods for accessing a person.  A person can be a student, advisor, or any other type of individual in the system.

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

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "createdDate" : 1331269200000,
      "createdBy" :
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"}, 
      "modifiedDate" : 1331269200000,
      "modifiedBy" :
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"}, 
      "objectStatus" : "ACTIVE",
      "firstName" : "Sally",
      "middleInitial" : null,
      "lastName" : "Student",
      "birthDate" : null,
      "primaryEmailAddress" : "sally.student@university.edu",
      "secondaryEmailAddress" : null,
      "username" : "sally.student",
      "userId" : null,
      "homePhone" : "123-456-7890",
      "workPhone" : null,
      "cellPhone" : null,
      "addressLine1" : "444 West Third Street",
      "addressLine2" : null,
      "city" : "Dayton",
      "state" : "OH",
      "zipCode" : "45402",
      "photoUrl" : null,
      "schoolId" : null,
      "enabled" : false,
      "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"},
          ...
         ],
      "referralSourceIds" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
          {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
          ...
         ],
      "serviceReasonIds" : 
         [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
          {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
          ...
         ],
      "currentProgramStatusName" : "Active",
      "currentAppointmentStartDate" : 1331269200000,
      "registeredForCurrentTerm" : true},
     {"id" : "63d62297-bf08-496f-acf3-0c129d437c2b",
      "createdDate" : 1331269200000,
      "createdBy" :
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"}, 
      "modifiedDate" : 1331269200000,
      "modifiedBy" :
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"}, 
      "objectStatus" : "ACTIVE",
      "firstName" : "Bill",
      "middleInitial" : null,
      "lastName" : "Smith",
      "birthDate" : null,
      "primaryEmailAddress" : "bill.smith@university.edu",
      "secondaryEmailAddress" : null,
      "username" : "bill.smith",
      "userId" : null,
      "homePhone" : "987-65-4321",
      "workPhone" : null,
      "cellPhone" : null,
      "addressLine1" : "110 North Front Street",
      "addressLine2" : null,
      "city" : "Dayton",
      "state" : "OH",
      "zipCode" : "45402",
      "photoUrl" : null,
      "schoolId" : null,
      "enabled" : false,
      "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" : "Great communication skills",
      "abilityToBenefit" : null,
      "anticipatedStartTerm" : "Spring",
      "anticipatedStartYear" : "2013",
      "studentType" :
         {"id" : "e34b0d14-f6f0-4adb-85c6-694de9fc0685",
          "name" : "Transfer"},
      "studentIntakeRequestDate" : null,
      "specialServiceGroupIds" : 
         [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
          {"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
          ...
         ],
      "referralSourceIds" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
          {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
          ...
         ],
      "serviceReasonIds" : 
         [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
          {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
          ...
         ],
      "currentProgramStatusName" : "Non-participating",
      "currentAppointmentStartDate" : null,
      "registeredForCurrentTerm" : true},
      ...
    ]
}

 

Get All Persons Who Are Coaches

This method calls the corresponding uPlatform API to obtain those individuals assigned the Coach group.

GET /ssp/api/1/person/coach

Security

PERSON_READ

Returns 

List<PersonLiteTO> 

Returns

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "firstName" : "Camden",
      "lastName" : "Coach",
      "primaryEmailAddress" : "camden.coach@university.edu",
      "workPhone" : "(123) 313-2837",
      "officeLocation" : "Stiller Hall Room 132",
      "departmentName" : "Management & Accounting"},
     {"id" : "63d62297-bf08-496f-acf3-0c129d437c2b",
      "firstName" : "Christina",
      "lastName" : "Coach",
      "primaryEmailAddress" : "christina.coach@university.edu",
      "workPhone" : "(323) 322-2907",
      "officeLocation" : "Krieger Hall Room 9",
      "departmentName" : "Psychology"},
      ...
    ]
}

 

Get a Person

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

Security

PERSON_READ

Returns

Person

{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "modifiedDate" : 1331269200000,
 "modifiedBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "objectStatus" : "ACTIVE",
 "firstName" : "Sally",
 "middleInitial" : null,
 "lastName" : "Student",
 "birthDate" : null,
 "primaryEmailAddress" : "sally.student@university.edu",
 "secondaryEmailAddress" : null,
 "username" : "sally.student",
 "userId" : null,
 "homePhone" : "123-456-7890",
 "workPhone" : null,
 "cellPhone" : null,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "photoUrl" : null,
 "schoolId" : null,
 "enabled" : false,
 "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"},
     ...
    ],
 "referralSourceIds" : 
    [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
     {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
     ...
    ],
 "serviceReasonIds" : 
    [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
     {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
     ...
    ],
 "currentProgramStatusName" : "Active",
 "currentAppointmentStartDate" : 1331269200000,
 "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

{"firstName" : "Sally",
 "middleInitial" : null,
 "lastName" : "Student",
 "birthDate" : null,
 "primaryEmailAddress" : "sally.student@university.edu",
 "secondaryEmailAddress" : null,
 "username" : "sally.student",
 "userId" : null,
 "homePhone" : "123-456-7890",
 "workPhone" : null,
 "cellPhone" : null,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "photoUrl" : null,
 "schoolId" : null,
 "enabled" : false,
 "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"},
     ...
    ],
 "referralSourceIds" : 
    [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
     {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
     ...
    ],
 "serviceReasonIds" : 
    [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
     {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
     ...
    ],
 "currentProgramStatusName" : "Active",
 "currentAppointmentStartDate" : 1331269200000,
 "registeredForCurrentTerm" : null
}

Returns

Person

{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "modifiedDate" : 1331269200000,
 "modifiedBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "objectStatus" : "ACTIVE",
 "firstName" : "Sally",
 "middleInitial" : null,
 "lastName" : "Student",
 "birthDate" : null,
 "primaryEmailAddress" : "sally.student@university.edu",
 "secondaryEmailAddress" : null,
 "username" : "sally.student",
 "userId" : null,
 "homePhone" : "123-456-7890",
 "workPhone" : null,
 "cellPhone" : null,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "photoUrl" : null,
 "schoolId" : null,
 "enabled" : false,
 "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"},
     ...
    ],
 "referralSourceIds" : 
    [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
     {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
     ...
    ],
 "serviceReasonIds" : 
    [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
     {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
     ...
    ],
 "currentProgramStatusName" : "Active",
 "currentAppointmentStartDate" : 1331269200000,
 "registeredForCurrentTerm" : 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

{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "modifiedDate" : 1331269200000,
 "modifiedBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "objectStatus" : "ACTIVE",
 "firstName" : "Sally",
 "middleInitial" : null,
 "lastName" : "Student",
 "birthDate" : null,
 "primaryEmailAddress" : "sally.student@university.edu",
 "secondaryEmailAddress" : null,
 "username" : "sally.student",
 "userId" : null,
 "homePhone" : "123-456-7890",
 "workPhone" : null,
 "cellPhone" : null,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "photoUrl" : null,
 "schoolId" : null,
 "enabled" : false,
 "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"},
     ...
    ],
 "referralSourceIds" : 
    [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
     {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
     ...
    ],
 "serviceReasonIds" : 
    [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
     {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
     ...
    ],
 "currentProgramStatusName" : "Active",
 "currentAppointmentStartDate" : 1331269200000,
 "registrationStatusForCurrentTerm" : true
}

Returns

Person

{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "modifiedDate" : 1331269200000,
 "modifiedBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "objectStatus" : "ACTIVE",
 "firstName" : "Sally",
 "middleInitial" : null,
 "lastName" : "Student",
 "birthDate" : null,
 "primaryEmailAddress" : "sally.student@university.edu",
 "secondaryEmailAddress" : null,
 "username" : "sally.student",
 "userId" : null,
 "homePhone" : "123-456-7890",
 "workPhone" : null,
 "cellPhone" : null,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "photoUrl" : null,
 "schoolId" : null,
 "enabled" : false,
 "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"},
     ...
    ],
 "referralSourceIds" : 
    [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
     {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
     ...
    ],
 "serviceReasonIds" : 
    [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
     {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
     ...
    ],
 "currentProgramStatusName" : "Active",
 "currentAppointmentStartDate" : 1331269200000,
 "registeredForCurrentTerm" : true
}

 

Delete a Person

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

Security

PERSON_DELETE

Returns

{"success" : "true"}

or

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


Get History for Person

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

Security

PERSON_READ

Parameters

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

Returns

PDF Report - To be completed by Unicon

  • No labels