AbodeONE

<back to all web services

FindCurrentResidents

Requires Authentication
The following routes are available for this service:
All Verbs/residents/current
FindCurrentResidentsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<StudentDTO>No
ResponseStatusformResponseStatusNo
StudentDTO Parameters:
NameParameterData TypeRequiredDescription
StudentIdformintNo
SchoolIdformstringNo
IdSerialformstringNo
UsernameformstringNo
DisplayNameformstringNo
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
NickNameformstringNo
BirthdayformDateTime?No
GenderformstringNo
EthnicIdformstringNo
TshirtSizeformstringNo
ReligionformstringNo
AgeformintNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalformstringNo
CountryformstringNo
PhotoFilenameformstringNo
ImageUrlformstringNo
EmailformstringNo
Email2formstringNo
HomephoneformstringNo
SummerphoneformstringNo
CellphoneformstringNo
SmsPermissionformstringNo
OtherphoneformstringNo
Contact1formstringNo
Contact2formstringNo
Contact1RelationformstringNo
Contact2RelationformstringNo
Contactphone1formstringNo
Contactphone2formstringNo
ContactcommentsformstringNo
Emergency1ContactformstringNo
Emergency1RelationformstringNo
Emergency1Address1formstringNo
Emergency1Address2formstringNo
Emergency1CityformstringNo
Emergency1StateformstringNo
Emergency1PostalformstringNo
Emergency1HomePhoneformstringNo
Emergency1WorkPhoneformstringNo
Emergency1PagerPhoneformstringNo
Emergency1CellPhoneformstringNo
Emergency1OtherPhoneformstringNo
Emergency2ContactformstringNo
Emergency2RelationformstringNo
Emergency2Address1formstringNo
Emergency2Address2formstringNo
Emergency2CityformstringNo
Emergency2StateformstringNo
Emergency2PostalformstringNo
Emergency2CountryformstringNo
Emergency2HomePhoneformstringNo
Emergency2WorkPhoneformstringNo
Emergency2CellPhoneformstringNo
Emergency2OtherPhoneformstringNo
Emergency2EmailformstringNo
DepositReceivedformDateTime?No
DepositRefundedformDateTime?No
FinClearformstringNo
EnrollmentFeePaidformstringNo
ClassIdformstringNo
ClassStandingformstringNo
Gpaformdecimal?No
ArrivingYearformstringNo
ArrivingTermformstringNo
GraduatingformstringNo
GraduatingTermIdformstringNo
CreditLoadformint?No
TermsAttendedformint?No
CreditsCompletedformint?No
Major1formstringNo
Major2formstringNo
Major3formstringNo
Minor1formstringNo
Minor2formstringNo
Minor3formstringNo
HighschoolformstringNo
Hsgpaformdecimal?No
AssignedformintNo
CheckedInformintNo
IntendHousingformstringNo
BuildingIdformint?No
RoomformstringNo
ReserveBuildingIdformint?No
ReserveRoomformstringNo
CurfewIdformstringNo
CurfewDefaultIdformstringNo
GraceformstringNo
CurfewOverrideformstringNo
CurfewRestrictedformstringNo
WorshipReqIdformstringNo
WorshipDefaultIdformstringNo
WorshipOverrideformstringNo
WorshipRestrictedformstringNo
PreventLeavesformstringNo
LeavePermissionFrom1formstringNo
LeavePermissionFrom2formstringNo
LeavePermissionFrom3formstringNo
LeavePermissionFrom4formstringNo
LeavePermissionFrom5formstringNo
LeavePermissionFrom6formstringNo
ParentalContactformstringNo
LeavePermissionsformstringNo
VisitLocalformstringNo
ParentSignedformstringNo
ParentSignDateformDateTime?No
StudentSignDateformDateTime?No
MedicalNotesformstringNo
MedicalArrangementsformstringNo
PhysicianformstringNo
PhysicianPhoneformstringNo
InsuranceCompanyformstringNo
InsurancePolicyformstringNo
MedicalDiseaseformstringNo
MedicalAllergiesformstringNo
MedicalMedicationAllergiesformstringNo
MedicalOngoingformstringNo
MedicalSpecialTreatmentformstringNo
MedicalOnMedsformstringNo
MedicalCarePermissionformstringNo
MedicalMedicationsformstringNo
WingIdformintNo

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.

POST //residents/current HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"results":[{"studentId":0,"schoolId":"String","idSerial":"String","username":"String","displayName":"String","firstName":"String","middleName":"String","lastName":"String","nickName":"String","birthday":"0001-01-01T00:00:00.0000000","gender":"String","ethnicId":"String","tshirtSize":"String","religion":"String","age":0,"address1":"String","address2":"String","city":"String","state":"String","postal":"String","country":"String","photoFilename":"String","imageUrl":"String","email":"String","email2":"String","homephone":"String","summerphone":"String","cellphone":"String","smsPermission":"String","otherphone":"String","contact1":"String","contact2":"String","contact1Relation":"String","contact2Relation":"String","contactphone1":"String","contactphone2":"String","contactcomments":"String","emergency1Contact":"String","emergency1Relation":"String","emergency1Address1":"String","emergency1Address2":"String","emergency1City":"String","emergency1State":"String","emergency1Postal":"String","emergency1HomePhone":"String","emergency1WorkPhone":"String","emergency1PagerPhone":"String","emergency1CellPhone":"String","emergency1OtherPhone":"String","emergency2Contact":"String","emergency2Relation":"String","emergency2Address1":"String","emergency2Address2":"String","emergency2City":"String","emergency2State":"String","emergency2Postal":"String","emergency2Country":"String","emergency2HomePhone":"String","emergency2WorkPhone":"String","emergency2CellPhone":"String","emergency2OtherPhone":"String","emergency2Email":"String","depositReceived":"0001-01-01T00:00:00.0000000","depositRefunded":"0001-01-01T00:00:00.0000000","finClear":"String","enrollmentFeePaid":"String","classId":"String","classStanding":"String","gpa":0,"arrivingYear":"String","arrivingTerm":"String","graduating":"String","graduatingTermId":"String","creditLoad":0,"termsAttended":0,"creditsCompleted":0,"major1":"String","major2":"String","major3":"String","minor1":"String","minor2":"String","minor3":"String","highschool":"String","hsgpa":0,"assigned":0,"checkedIn":0,"intendHousing":"String","buildingId":0,"room":"String","reserveBuildingId":0,"reserveRoom":"String","curfewId":"String","curfewDefaultId":"String","grace":"String","curfewOverride":"String","curfewRestricted":"String","worshipReqId":"String","worshipDefaultId":"String","worshipOverride":"String","worshipRestricted":"String","preventLeaves":"String","leavePermissionFrom1":"String","leavePermissionFrom2":"String","leavePermissionFrom3":"String","leavePermissionFrom4":"String","leavePermissionFrom5":"String","leavePermissionFrom6":"String","parentalContact":"String","leavePermissions":"String","visitLocal":"String","parentSigned":"String","parentSignDate":"0001-01-01T00:00:00.0000000","studentSignDate":"0001-01-01T00:00:00.0000000","medicalNotes":"String","medicalArrangements":"String","physician":"String","physicianPhone":"String","insuranceCompany":"String","insurancePolicy":"String","medicalDisease":"String","medicalAllergies":"String","medicalMedicationAllergies":"String","medicalOngoing":"String","medicalSpecialTreatment":"String","medicalOnMeds":"String","medicalCarePermission":"String","medicalMedications":"String","wingId":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}