KxEPOS

Click here for a complete list of operations.

FindDelegateByName

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /KxEpos/KxEPOS.asmx HTTP/1.1
Host: www.kxonline.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://kxonline.co.uk/webservices/FindDelegateByName"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FindDelegateByName xmlns="http://kxonline.co.uk/webservices/">
      <name>string</name>
      <siteid>int</siteid>
      <areaid>int</areaid>
    </FindDelegateByName>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FindDelegateByNameResponse xmlns="http://kxonline.co.uk/webservices/">
      <FindDelegateByNameResult>
        <Results>
          <BedroomOccupant>
            <PersonID>int</PersonID>
            <EventModuleID>int</EventModuleID>
            <ArrivalDate>dateTime</ArrivalDate>
            <DepartureDate>dateTime</DepartureDate>
            <PersonName>string</PersonName>
            <AllowBarPosting>boolean</AllowBarPosting>
            <RoomName>string</RoomName>
            <EventID>string</EventID>
            <EventTitle>string</EventTitle>
          </BedroomOccupant>
          <BedroomOccupant>
            <PersonID>int</PersonID>
            <EventModuleID>int</EventModuleID>
            <ArrivalDate>dateTime</ArrivalDate>
            <DepartureDate>dateTime</DepartureDate>
            <PersonName>string</PersonName>
            <AllowBarPosting>boolean</AllowBarPosting>
            <RoomName>string</RoomName>
            <EventID>string</EventID>
            <EventTitle>string</EventTitle>
          </BedroomOccupant>
        </Results>
        <Error>
          <ErrorNumber>int</ErrorNumber>
          <ErrorCode>NO_ERROR or CONNECTION_ERROR or INVALID_ROOMACCOUNT or INVALID_EVENT or CANNOT_POST_FROM_BAR or NO_OCCUPANTS or NO_DELEGATESFOUND or INVALID_CHARGETO or INVALID_CHARGE</ErrorCode>
          <ErrorText>string</ErrorText>
        </Error>
      </FindDelegateByNameResult>
    </FindDelegateByNameResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /KxEpos/KxEPOS.asmx HTTP/1.1
Host: www.kxonline.co.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FindDelegateByName xmlns="http://kxonline.co.uk/webservices/">
      <name>string</name>
      <siteid>int</siteid>
      <areaid>int</areaid>
    </FindDelegateByName>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FindDelegateByNameResponse xmlns="http://kxonline.co.uk/webservices/">
      <FindDelegateByNameResult>
        <Results>
          <BedroomOccupant>
            <PersonID>int</PersonID>
            <EventModuleID>int</EventModuleID>
            <ArrivalDate>dateTime</ArrivalDate>
            <DepartureDate>dateTime</DepartureDate>
            <PersonName>string</PersonName>
            <AllowBarPosting>boolean</AllowBarPosting>
            <RoomName>string</RoomName>
            <EventID>string</EventID>
            <EventTitle>string</EventTitle>
          </BedroomOccupant>
          <BedroomOccupant>
            <PersonID>int</PersonID>
            <EventModuleID>int</EventModuleID>
            <ArrivalDate>dateTime</ArrivalDate>
            <DepartureDate>dateTime</DepartureDate>
            <PersonName>string</PersonName>
            <AllowBarPosting>boolean</AllowBarPosting>
            <RoomName>string</RoomName>
            <EventID>string</EventID>
            <EventTitle>string</EventTitle>
          </BedroomOccupant>
        </Results>
        <Error>
          <ErrorNumber>int</ErrorNumber>
          <ErrorCode>NO_ERROR or CONNECTION_ERROR or INVALID_ROOMACCOUNT or INVALID_EVENT or CANNOT_POST_FROM_BAR or NO_OCCUPANTS or NO_DELEGATESFOUND or INVALID_CHARGETO or INVALID_CHARGE</ErrorCode>
          <ErrorText>string</ErrorText>
        </Error>
      </FindDelegateByNameResult>
    </FindDelegateByNameResponse>
  </soap12:Body>
</soap12:Envelope>