AbodeONE

<back to all web services

GetStudentProfile

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/students/{Schoolid}/profile
GetStudentProfile Parameters:
NameParameterData TypeRequiredDescription
SchoolidpathstringYes
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
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

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

HTTP + CSV

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

GET /students/{Schoolid}/profile HTTP/1.1 
Host: api.oau.abodehms.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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