AbodeONE

<back to all web services

GetHousingPoolMember

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/housing_pool_members/{Id}
GetHousingPoolMember Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
GetHousingPoolMemberResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformHousingPoolMemberDTONo
ResponseStatusformResponseStatusNo
HousingPoolMemberDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
HousingPoolIdformintNo
StudentIdformintNo
AppIdformint?No
CopiedFromHousingPoolIdformint?No
FuturePlanResponseIdformint?No
MemberStatusformHousingPoolMemberStatus?No
MemberStatusDtformDateTime?No
MemberStatusUsernameformstringNo
ArrivalDtformDateTimeNo
RequestAssignedRoommateformbool?No
IsRaformbool?No
FeeTypeformHousingPoolMemberFeeType?No
FeeAmountformintNo
FeeStatusformHousingPoolMemberFeeStatus?No
FeeStatusDtformDateTime?No
FeeUsernameformstringNo
RoomAloneStatusformHousingPoolMemberRoomAloneStatus?No
RoomAloneStatusDtformDateTime?No
RoomAloneUsernameformstringNo
PriorityScoreformint?No
PriorityRankformint?No
CommentsformstringNo
ApprovalDtformDateTime?No
ApprovalReasonformstringNo
ApprovalUserformstringNo
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTime?No
ModifiedByformstringNo
HousingPoolMemberStatus Enum:
Active
Waitlist
Denied
Requested
Canceled
HousingPoolMemberFeeType Enum:
Deposit
Onetime
Annual
Session
None
HousingPoolMemberFeeStatus Enum:
Paid
Refunded
Unknown
Unpaid
HousingPoolMemberRoomAloneStatus Enum:
NotRequested
Requested
Denied
Approved

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

<GetHousingPoolMemberResponse 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>
    <AppId>0</AppId>
    <ApprovalDt>0001-01-01T00:00:00</ApprovalDt>
    <ApprovalReason>String</ApprovalReason>
    <ApprovalUser>String</ApprovalUser>
    <ArrivalDt>0001-01-01T00:00:00</ArrivalDt>
    <Comments>String</Comments>
    <CopiedFromHousingPoolId>0</CopiedFromHousingPoolId>
    <CreatedBy>String</CreatedBy>
    <CreatedDt>0001-01-01T00:00:00</CreatedDt>
    <FeeAmount>0</FeeAmount>
    <FeeStatus>Paid</FeeStatus>
    <FeeStatusDt>0001-01-01T00:00:00</FeeStatusDt>
    <FeeType>Deposit</FeeType>
    <FeeUsername>String</FeeUsername>
    <FuturePlanResponseId>0</FuturePlanResponseId>
    <HousingPoolId>0</HousingPoolId>
    <Id>0</Id>
    <IsRa>false</IsRa>
    <MemberStatus>Active</MemberStatus>
    <MemberStatusDt>0001-01-01T00:00:00</MemberStatusDt>
    <MemberStatusUsername>String</MemberStatusUsername>
    <ModifiedBy>String</ModifiedBy>
    <ModifiedDt>0001-01-01T00:00:00</ModifiedDt>
    <PriorityRank>0</PriorityRank>
    <PriorityScore>0</PriorityScore>
    <RequestAssignedRoommate>false</RequestAssignedRoommate>
    <RoomAloneStatus>NotRequested</RoomAloneStatus>
    <RoomAloneStatusDt>0001-01-01T00:00:00</RoomAloneStatusDt>
    <RoomAloneUsername>String</RoomAloneUsername>
    <StudentId>0</StudentId>
  </Result>
</GetHousingPoolMemberResponse>