AbodeONE

<back to all web services

GetMoveOutResidentState

Requires Authentication
The following routes are available for this service:
GET/student/{StudentId}/move_out
GET/resident/{ResidentId}/move_out
GetMoveOutResidentState Parameters:
NameParameterData TypeRequiredDescription
StudentIdpathint?No
SchoolIdquerystringNo
ResidentIdpathint?No
MoveOutResidentStateResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformMoveOutResidentStateDTONo
ResponseStatusformResponseStatusNo
MoveOutResidentStateDTO Parameters:
NameParameterData TypeRequiredDescription
StudentIdformintNo
ResidentIdformint?No
InspectionIdformint?No
MoveOutStateformMoveOutStateEnumNo

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 /student/{StudentId}/move_out HTTP/1.1 
Host: api.oau.abodehms.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":{"studentId":0,"residentId":0,"inspectionId":0,"moveOutState":"ForwadingAddress"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}