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 .xml suffix or ?format=xml

HTTP + XML

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-staging.abodehms.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MoveOutResidentStateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <MoveOutState>ForwardingAddress</MoveOutState>
    <ResidentId>0</ResidentId>
    <StudentId>0</StudentId>
  </Result>
</MoveOutResidentStateResponse>