AbodeONE

<back to all web services

FindGuestChaperones

Requires Authentication
Requires any of the roles:Admin, HeadChaperone
The following routes are available for this service:
GET/chaperones
FindGuestChaperones Parameters:
NameParameterData TypeRequiredDescription
GuestEventIdqueryint?No
FirstNamequerystringNo
LastNamequerystringNo
HotelNamequerystringNo
HeadChaperoneIdqueryint?No
GroupStatusqueryChaperoneGroupStatusEnum?No
ChaperoneGroupStatusEnum Enum:
Head
Invited
Member
Requested
None
GuestChaperonesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<GuestChaperoneDTO>No
ResponseStatusformResponseStatusNo
GuestChaperoneDTO Parameters:
NameParameterData TypeRequiredDescription
ChaperoneIdformintNo
GuestEventIdformintNo
FirstNameformstringNo
LastNameformstringNo
UsernameformstringNo
GenderformstringNo
PhoneformstringNo
EmailformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalformstringNo
CountryformstringNo
ExpectedArrivalDtformDateTime?No
ExpectedDepartureDtformDateTime?No
AmtPaidformdecimal?No
AppliedAmountformdecimal?No
AppliedByformstringNo
TshirtSizeformstringNo
SchoolOrgformstringNo
HotelNameformstringNo
HotelPhoneformstringNo
CodeformstringNo
InviteCodeformstringNo
TotalPaidAmountformdecimalNo
AvailableAmountformdecimalNo
NeedsTransportformboolNo
TransportDestformstringNo
TransportDetailsformstringNo
HeadChaperoneIdformint?No
IsPaidformboolNo
InvitedDtformDateTime?No
LastLoginDtformDateTime?No
GroupStatusformstringNo
FullNameformstringNo
HeadChaperoneFullNameformstringNo
GuestEventNameformstringNo
PasswordResetLinkformstringNo
EventStartDtformDateTime?No
EventEndDtformDateTime?No

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

<GuestChaperonesResponse 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>
    <GuestChaperoneDTO>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <AmtPaid>0</AmtPaid>
      <AppliedAmount>0</AppliedAmount>
      <AppliedBy>String</AppliedBy>
      <AvailableAmount>0</AvailableAmount>
      <ChaperoneId>0</ChaperoneId>
      <City>String</City>
      <Code>String</Code>
      <Country>String</Country>
      <Email>String</Email>
      <EventEndDt>0001-01-01T00:00:00</EventEndDt>
      <EventStartDt>0001-01-01T00:00:00</EventStartDt>
      <ExpectedArrivalDt>0001-01-01T00:00:00</ExpectedArrivalDt>
      <ExpectedDepartureDt>0001-01-01T00:00:00</ExpectedDepartureDt>
      <FirstName>String</FirstName>
      <FullName>String</FullName>
      <Gender>String</Gender>
      <GroupStatus>String</GroupStatus>
      <GuestEventId>0</GuestEventId>
      <GuestEventName>String</GuestEventName>
      <HeadChaperoneFullName>String</HeadChaperoneFullName>
      <HeadChaperoneId>0</HeadChaperoneId>
      <HotelName>String</HotelName>
      <HotelPhone>String</HotelPhone>
      <InviteCode>String</InviteCode>
      <InvitedDt>0001-01-01T00:00:00</InvitedDt>
      <IsPaid>false</IsPaid>
      <LastLoginDt>0001-01-01T00:00:00</LastLoginDt>
      <LastName>String</LastName>
      <NeedsTransport>false</NeedsTransport>
      <PasswordResetLink>String</PasswordResetLink>
      <Phone>String</Phone>
      <Postal>String</Postal>
      <SchoolOrg>String</SchoolOrg>
      <State>String</State>
      <TotalPaidAmount>0</TotalPaidAmount>
      <TransportDest>String</TransportDest>
      <TransportDetails>String</TransportDetails>
      <TshirtSize>String</TshirtSize>
      <Username>String</Username>
    </GuestChaperoneDTO>
  </Result>
</GuestChaperonesResponse>