Page Comparison

...

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

...

Code Block

{"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",
      "middleInitialmiddleName" : 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,
      "enabled" : false,
      "studentIntakeCompleteDate" : null,
      "studentType" :
         {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
          "name" : "Early Alert"
          "objectStatus":"ACTIVE"},},
      "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",
      "actualStartTerm":"Fall",
      "actualStartYear":2012,
      "studentIntakeRequestDate" : 1331269200000,
      "specialServiceGroupIdsspecialServiceGroups" : 
         [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
		   "name" : "Basketball Team",	
		   "objectStatus" : "ACTIVE"}
         ],
      "referralSourceIdsreferralSources" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
		   "name" : "Counseling Services".
		   "objectStatus" : "ACTIVE"},
         ],
      "serviceReasonIdsserviceReasons" : 
         [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		   "name" : "Developmental Education",
		   "objectStatus" : "ACTIVE"}
         ],
      "confidentialityLevels" : null,  
      "permissions" : null,
      "currentProgramStatusName" : "Active",
      "registeredForCurrentTerm" : true}
      "activeAlertsCount":1,
     ]
}

Get All Persons Who Are Coaches

...

 "closedAlertsCount":2,
      "paymentStatus":"Y Y Y",
      "registeredTerms":"2013FA 2013SP 2013SU"}
    ]
}

Get All Persons Who Are Coaches

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

...

Code Block

{"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",
 "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,
 "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",
 "actualStartTerm":"Fall",
 "actualStartYear":2012,
 "studentType" :
    {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
     "name" : "Early Alert"},
 "studentIntakeRequestDate" : 1331269200000,
 "specialServiceGroupIdsspecialServiceGroups" : 
    [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
	       "name" : "Basketball Team",	
		   "objectStatus" : "ACTIVE"}
         ],
 "referralSourceIdsreferralSources" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
		   "name" : "Counseling Services".
		   "objectStatus" : "ACTIVE"},
         ],
 "serviceReasonIdsserviceReasons" : 
         [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
		   "name" : "Developmental Education",
		   "objectStatus" : "ACTIVE"}
         ],
 "confidentialityLevels" : null,  
 "permissions" : null,
 "currentProgramStatusName" : "Active",
 "registeredForCurrentTerm" : true
} "activeAlertsCount":1,
 "closedAlertsCount":2,
 "paymentStatus":"Y Y Y",
 "registeredTerms":"2013FA 2013SP 2013SU"
}

Get a Person by School ID

...

Code Block

{"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",
 "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,
 "studentIntakeCompleteDate" : 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",
 "actualStartTerm":"Fall",
 "actualStartYear":2012,
 "studentType" :
    {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
     "name" : "Early Alert"},
 "studentIntakeRequestDate" : 1331269200000,
 "specialServiceGroupIdsspecialServiceGroups" : 
         [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
           "name" : "Basketball Team",    
           "objectStatus" : "ACTIVE"}
         ],
 "referralSourceIdsreferralSources" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
           "name" : "Counseling Services".
           "objectStatus" : "ACTIVE"},
         ],
 "serviceReasonIdsserviceReasons" : 
         [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
           "name" : "Developmental Education",
           "objectStatus" : "ACTIVE"}
         ],
 "confidentialityLevels" : null,  
 "permissions" : null,
 "currentProgramStatusName" : "Active",
 "registeredForCurrentTerm" : true
 "activeAlertsCount":1,
 "closedAlertsCount":2,
 "paymentStatus":"Y Y Y",
 "registeredTerms":"2013FA 2013SP 2013SU"
}

Create a Person

POST /ssp/api/1/person

...

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,
 "enabled" : false,
 "studentIntakeCompleteDate" : null,
 "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",
 "actualStartTerm":"Fall",
 "actualStartYear":2012,
 "studentType" :
    {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
     "name" : "Early Alert"},
 "studentIntakeRequestDate" : 1331269200000,
 "specialServiceGroupIdsspecialServiceGroups" : 
         [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
           "name" : "Basketball Team",    
           "objectStatus" : "ACTIVE"}
         ],
 "referralSourceIdsreferralSources" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
           "name" : "Counseling Services".
           "objectStatus" : "ACTIVE"},
         ],
 "serviceReasonIdsserviceReasons" : 
         [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
           "name" : "Developmental Education",
           "objectStatus" : "ACTIVE"}
         ],
 "confidentialityLevels" : null,  
 "permissions" : null,
 "currentProgramStatusName" : "Active",
 "registeredForCurrentTerm" : null,
 "activeAlertsCount":1,
 "permissionsclosedAlertsCount" : null2,
 "paymentStatus"currentProgramStatusName:"Y :Y "ActiveY",
 "registeredForCurrentTermregisteredTerms":"2013FA :2013SP null2013SU"
}

Returns

Person

Code Block

{"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",
 "homePhone" : "123-456-7890",
 "workPhone" : null,
 "cellPhone" : null,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "nonLocalAddress" : null,
 "alternateAddressLineInUse" : null,
 "alternateAddressLine1" : null,
 "alternateAddressLine2" : null,
 "alternateAddressCity" : null,
 "alternateAddressState" : null,
 "alternateAddressZipCode" : null,
 "alternateAddressCountry" : null,
 "photoUrl" : null,
 "schoolId" : null,
 "enabled" : false,
 "studentIntakeCompleteDate" : null,
 "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",
 "actualStartTerm":"Fall",
 "actualStartYear":2012,
 "studentType" :
    {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
     "name" : "Early Alert"},
 "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
 "activeAlertsCount":1,
 "closedAlertsCount": true2,
 "paymentStatus":"Y Y Y",
 "registeredTerms":"2013FA 2013SP 2013SU"
}

Save a Person

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

...

Code Block

{"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",
 "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,
 "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",
 "actualStartTerm":"Fall",
 "actualStartYear":2012,
 "studentType" :
    {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
     "name" : "Early Alert"},
 "studentIntakeRequestDate" : 1331269200000,
 "specialServiceGroupIdsspecialServiceGroups" : 
         [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
           "name" : "Basketball Team",    
           "objectStatus" : "ACTIVE"}
         ],
 "referralSourceIdsreferralSources" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
           "name" : "Counseling Services".
           "objectStatus" : "ACTIVE"},
         ],
 "serviceReasonIdsserviceReasons" : 
         [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
           "name" : "Developmental Education",
           "objectStatus" : "ACTIVE"}
         ],
 "confidentialityLevels" : null,  
 "permissions" : null,
 "currentProgramStatusName" : "Active",
 "registrationStatusForCurrentTerm" : true

}

Returns

Person

Code Block

{"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",
 "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,
 "studentIntakeCompleteDate" : 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",
 "actualStartTerm":"Fall",
 "actualStartYear":2012,
 "studentType" :
    {"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
     "name" : "Early Alert"},
 "studentIntakeRequestDate" : 1331269200000,
 "specialServiceGroupIdsspecialServiceGroups" : 
         [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
           "name" : "Basketball Team",    
           "objectStatus" : "ACTIVE"}
         ],
 "referralSourceIdsreferralSources" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
           "name" : "Counseling Services".
           "objectStatus" : "ACTIVE"},
         ],
 "serviceReasonIdsserviceReasons" : 
         [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
           "name" : "Developmental Education",
           "objectStatus" : "ACTIVE"}
         ],
 "confidentialityLevels" : null,  
 "permissions" : null,
 "currentProgramStatusName" : "Active",
 "registeredForCurrentTerm" : true
 "activeAlertsCount":1,
 "closedAlertsCount":2,
 "paymentStatus":"Y Y Y",
 "registeredTerms":"2013FA 2013SP 2013SU"
}

Delete a Person

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

...

Versions Compared

Old Version 46

New Version 47

Key

Get All Persons

Get All Persons Who Are Coaches

Get All Persons Who Are Coaches

Get a Person by School ID

Create a Person

Save a Person

Delete a Person