AbodeONE

<back to all web services

FindGuests

Requires Authentication
Requires any of the roles:Admin, HeadChaperone
The following routes are available for this service:
GET/guests
FindGuests Parameters:
NameParameterData TypeRequiredDescription
GuestEventIdqueryint?No
GenderquerystringNo
SchoolOrgquerystringNo
ChaperoneIdqueryint?No
GuestStatusFilterqueryGuestStatusEnum?No
BuildingIdsqueryArrayOfIntNo
GuestStatusEnum Enum:
Resident
NotResident
AllGuests
GuestsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<GuestDTO>No
ResponseStatusformResponseStatusNo
GuestDTO Parameters:
NameParameterData TypeRequiredDescription
GuestIdformintNo
StudentIdformint?No
SchoolidformstringNo
ChaperoneIdformint?No
GuestEventIdformint?No
UsernameformstringNo
FirstNameformstringNo
LastNameformstringNo
GuestTypeformstringNo
GenderformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalformstringNo
CountryformstringNo
PhoneformstringNo
EmailformstringNo
SchoolOrgformstringNo
CodeformstringNo
NotesformstringNo
GroupStatusformstringNo
PaidAmountformdecimalNo
IsPaidformboolNo
AppliedAmountformdecimal?No
AppliedByformdecimal?No
TshirtSizeformstringNo
InvitedDtformDateTime?No
LastLoginDtformDateTime?No
FullNameformstringNo
StudentFullNameformstringNo
ChaperoneFullNameformstringNo
ChaperonePhoneformstringNo
ChaperoneHotelformstringNo
ChaperoneHotelPhoneformstringNo
GuestEventNameformstringNo
PasswordResetLinkformstringNo

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

<GuestsResponse 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>
    <GuestDTO>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <AppliedAmount>0</AppliedAmount>
      <AppliedBy>0</AppliedBy>
      <ChaperoneFullName>String</ChaperoneFullName>
      <ChaperoneHotel>String</ChaperoneHotel>
      <ChaperoneHotelPhone>String</ChaperoneHotelPhone>
      <ChaperoneId>0</ChaperoneId>
      <ChaperonePhone>String</ChaperonePhone>
      <City>String</City>
      <Code>String</Code>
      <Country>String</Country>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <FullName>String</FullName>
      <Gender>String</Gender>
      <GroupStatus>String</GroupStatus>
      <GuestEventId>0</GuestEventId>
      <GuestEventName>String</GuestEventName>
      <GuestId>0</GuestId>
      <GuestType>String</GuestType>
      <InvitedDt>0001-01-01T00:00:00</InvitedDt>
      <IsPaid>false</IsPaid>
      <LastLoginDt>0001-01-01T00:00:00</LastLoginDt>
      <LastName>String</LastName>
      <Notes>String</Notes>
      <PaidAmount>0</PaidAmount>
      <PasswordResetLink>String</PasswordResetLink>
      <Phone>String</Phone>
      <Postal>String</Postal>
      <SchoolOrg>String</SchoolOrg>
      <Schoolid>String</Schoolid>
      <State>String</State>
      <StudentFullName>String</StudentFullName>
      <StudentId>0</StudentId>
      <TshirtSize>String</TshirtSize>
      <Username>String</Username>
    </GuestDTO>
  </Result>
</GuestsResponse>