AbodeONE

<back to all web services

GetCurrentResident

Requires Authentication
The following routes are available for this service:
All Verbs/student/{StudentId}/residencies/current
GetCurrentResident Parameters:
NameParameterData TypeRequiredDescription
StudentIdpathintNo
ResidentResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformResidentDTONo
ResponseStatusformResponseStatusNo
ResidentDTO Parameters:
NameParameterData TypeRequiredDescription
ResidentIdformintNo
StudentIdformintNo
SchoolIdformstringNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
BedIdformintNo
MailboxformstringNo
RoomIdformintNo
RoomRateIdformint?No
RoomformstringNo
RoomCodeformstringNo
WingformstringNo
BuildingformstringNo
BuildingCodeformstringNo
MoveInDateformDateTime?No
MoveOutDateformDateTime?No
ReserveStartDtformDateTime?No
ReserveEndDtformDateTime?No
CheckInUserIdformint?No
CheckInUserformstringNo
StatusformstringNo
TermCodeformstringNo
DftBillingTypeformstringNo
BillingStartOptionformstringNo
BillingEndOptionformstringNo
IsBillableformboolNo

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.

POST //student/{StudentId}/residencies/current HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetCurrentResident xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <StudentId>0</StudentId>
</GetCurrentResident>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResidentResponse 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>
    <BedId>0</BedId>
    <BillingEndOption>String</BillingEndOption>
    <BillingStartOption>String</BillingStartOption>
    <Building>String</Building>
    <BuildingCode>String</BuildingCode>
    <CheckInUser>String</CheckInUser>
    <CheckInUserId>0</CheckInUserId>
    <DftBillingType>String</DftBillingType>
    <DisplayName>String</DisplayName>
    <FirstName>String</FirstName>
    <IsBillable>false</IsBillable>
    <LastName>String</LastName>
    <Mailbox>String</Mailbox>
    <MoveInDate>0001-01-01T00:00:00</MoveInDate>
    <MoveOutDate>0001-01-01T00:00:00</MoveOutDate>
    <ReserveEndDt>0001-01-01T00:00:00</ReserveEndDt>
    <ReserveStartDt>0001-01-01T00:00:00</ReserveStartDt>
    <ResidentId>0</ResidentId>
    <Room>String</Room>
    <RoomCode>String</RoomCode>
    <RoomId>0</RoomId>
    <RoomRateId>0</RoomRateId>
    <SchoolId>String</SchoolId>
    <Status>String</Status>
    <StudentId>0</StudentId>
    <TermCode>String</TermCode>
    <Wing>String</Wing>
  </Result>
</ResidentResponse>