AbodeONE

<back to all web services

GetGuestEventResidencyReport

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/guest_event/{GuestEventId}/guest_residents/report
GetGuestEventResidencyReport Parameters:
NameParameterData TypeRequiredDescription
GuestEventIdpathintNo
GuestResidentStatusquerystringNo
GuestResidentStatusesqueryList<string>No
BuildingIdsqueryArrayOfIntNo
GuestEventResidencyReportResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<GuestEventResidencyReportDTO>No
ResponseStatusformResponseStatusNo
GuestEventResidencyReportDTO Parameters:
NameParameterData TypeRequiredDescription
BuildingNameformstringNo
RoomNameformstringNo
HostSchoolidformstringNo
HostFirstNameformstringNo
HostLastNameformstringNo
HostFullNameformstringNo
GuestFirstNameformstringNo
GuestLastNameformstringNo
GuestFullNameformstringNo
GuestResidencyStatusformstringNo
MoveInDateformDateTimeNo
MoveOutDateformDateTimeNo
SchoolOrgformstringNo
HostPaymentformdecimal?No
ChaperoneFirstNameformstringNo
ChaperoneLastNameformstringNo
ChaperoneFullNameformstringNo
ChaperonePhoneformstringNo
HostPhoneformstringNo
GuestTypeformstringNo

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

<GuestEventResidencyReportResponse 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>
    <GuestEventResidencyReportDTO>
      <BuildingName>String</BuildingName>
      <ChaperoneFirstName>String</ChaperoneFirstName>
      <ChaperoneFullName>String</ChaperoneFullName>
      <ChaperoneLastName>String</ChaperoneLastName>
      <ChaperonePhone>String</ChaperonePhone>
      <GuestFirstName>String</GuestFirstName>
      <GuestFullName>String</GuestFullName>
      <GuestLastName>String</GuestLastName>
      <GuestResidencyStatus>String</GuestResidencyStatus>
      <GuestType>String</GuestType>
      <HostFirstName>String</HostFirstName>
      <HostFullName>String</HostFullName>
      <HostLastName>String</HostLastName>
      <HostPayment>0</HostPayment>
      <HostPhone>String</HostPhone>
      <HostSchoolid>String</HostSchoolid>
      <MoveInDate>0001-01-01T00:00:00</MoveInDate>
      <MoveOutDate>0001-01-01T00:00:00</MoveOutDate>
      <RoomName>String</RoomName>
      <SchoolOrg>String</SchoolOrg>
    </GuestEventResidencyReportDTO>
  </Result>
</GuestEventResidencyReportResponse>