AbodeONE

<back to all web services

GetStudentProfile

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/students/{StudentId}/profile
GetStudentProfile Parameters:
NameParameterData TypeRequiredDescription
SchoolIdquerystringNo
StudentIdpathint?No
GetStudentProfileResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformStudentProfileDTONo
ResponseStatusformResponseStatusNo
StudentProfileDTO Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
GenderformstringNo
AgeformintNo
EthnicityformstringNo
BirthdayformstringNo
ClassStandingformstringNo
TshirtSizeformstringNo
EmailformstringNo
CellphoneformstringNo
HomephoneformstringNo
SummerphoneformstringNo
ResidenceformStudentResidenceDTONo
AddressformStudentAddressDTONo
CurfewformStudentCurfewDTONo
GuardianformGuardianDTONo
EmergencyContactsformList<StudentEmergencyContactDTO>No
MedicalDetailsformStudentMedicalDTONo
StudentResidenceDTO Parameters:
NameParameterData TypeRequiredDescription
RoomformstringNo
BuildingformstringNo
StudentAddressDTO Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalformstringNo
StudentCurfewDTO Parameters:
NameParameterData TypeRequiredDescription
CurfewTypeformstringNo
CurfewDaysformDictionary<string, DateTime>No
LateLeaveDaysformDictionary<string, DateTime>No
GraceformstringNo
GuardianDTO Parameters:
NameParameterData TypeRequiredDescription
Contact1formstringNo
Contact1PhoneformstringNo
Contact1RelationformstringNo
Contact2formstringNo
Contact2PhoneformstringNo
Contact2RelationformstringNo
StudentEmergencyContactDTO Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
RelationformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalformstringNo
HomePhoneformstringNo
WorkPhoneformstringNo
PagerPhoneformstringNo
CellPhoneformstringNo
OtherPhoneformstringNo
StudentMedicalDTO Parameters:
NameParameterData TypeRequiredDescription
NotesformstringNo
ArrangementsformstringNo
PhysicianformstringNo
PhysicianPhoneformstringNo
InsuranceCompanyformstringNo
InsurancePolicyformstringNo
DiseaseformboolNo
AllergiesformboolNo
MedicationAllergiesformboolNo
OngoingformboolNo
SpecialTreatmentformboolNo
OnMedicationformboolNo
CarePermissionformstringNo
MedicationsformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET //students/{StudentId}/profile HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}