AbodeONE

<back to all web services

FindGuestResidents

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/guest_residents
FindGuestResidents Parameters:
NameParameterData TypeRequiredDescription
GuestRoomSlotIdqueryint?No
RoomIdqueryint?No
GuestEventIdqueryint?No
StudentIdqueryint?No
GuestIdqueryint?No
StatusquerystringNo
BuildingIdsqueryArrayOfIntNo
EmptyRoomSlotsquerybool?No
GuestResidentsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<GuestResidentDTO>No
ResponseStatusformResponseStatusNo
GuestResidentDTO Parameters:
NameParameterData TypeRequiredDescription
GuestResidentIdformintNo
GuestRoomSlotIdformintNo
RoomIdformintNo
GuestEventIdformint?No
StudentIdformint?No
GuestIdformint?No
IsAutoMoveoutformshortNo
StatusformstringNo
StartDtformDateTimeNo
EndDtformDateTimeNo
LastStatusUserformstringNo
LastStatusDtformDateTimeNo
MoveInUserformstringNo
MoveOutUserformstringNo
CreatedByformstringNo
CreatedDtformDateTimeNo
LastModifiedByformstringNo
LastModifiedDtformDateTimeNo
FirstNameformstringNo
LastNameformstringNo
FullNameformstringNo
BuildingIdformintNo
BuildingNameformstringNo
WingIdformintNo
WingNameformstringNo
RoomNameformstringNo

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

<GuestResidentsResponse 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>
    <GuestResidentDTO>
      <BuildingId>0</BuildingId>
      <BuildingName>String</BuildingName>
      <CreatedBy>String</CreatedBy>
      <CreatedDt>0001-01-01T00:00:00</CreatedDt>
      <EndDt>0001-01-01T00:00:00</EndDt>
      <FirstName>String</FirstName>
      <FullName>String</FullName>
      <GuestEventId>0</GuestEventId>
      <GuestId>0</GuestId>
      <GuestResidentId>0</GuestResidentId>
      <GuestRoomSlotId>0</GuestRoomSlotId>
      <IsAutoMoveout>0</IsAutoMoveout>
      <LastModifiedBy>String</LastModifiedBy>
      <LastModifiedDt>0001-01-01T00:00:00</LastModifiedDt>
      <LastName>String</LastName>
      <LastStatusDt>0001-01-01T00:00:00</LastStatusDt>
      <LastStatusUser>String</LastStatusUser>
      <MoveInUser>String</MoveInUser>
      <MoveOutUser>String</MoveOutUser>
      <RoomId>0</RoomId>
      <RoomName>String</RoomName>
      <StartDt>0001-01-01T00:00:00</StartDt>
      <Status>String</Status>
      <StudentId>0</StudentId>
      <WingId>0</WingId>
      <WingName>String</WingName>
    </GuestResidentDTO>
  </Result>
</GuestResidentsResponse>