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
StudentIdformint?No
ResidentIdformint?No
MoveOutStateformMoveOutStateEnumNo
MoveOutStateEnum Enum:
ForwardingAddress
Inspection
MoveOut
Complete

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

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