CiirusXMLAdditionalFunctions15025 Web Service

CiirusXMLAdditionalFunctions15025

Click here for a complete list of operations.

AddExtra

This can be used to add an extra to an existing BookingID.

Pass the following parameters:

APIUsername (String) *Required
APIPassword (String) *Required
BookingID (Integer) *Required
ItemCodeToAddToBooking (String) *Required
Note: You will need to use the function "GetExtras" in order to determine valid Extra Codes.

Error Responses:

AddExtra: Validation Error 1
AddExtra: Validation Error 2 - You do not have rights to this booking.
AddExtra: Error - CS Relation could not be resolved.
AddExtra: Validation Error 3 - You do not have access rights to this property.
AddExtra: Error 1 - Could not determine MC from PropertyID.
AddExtra: Error 2 - Could not determine MC from PropertyID.
AddExtra: Invalid ItemCode
AddExtra: Error 1 - Could not determine who the Payment was Taken By
AddExtra: Error 2 - Could not determine who the Payment was Taken By
AddExtra: Error 3 - Could not determine who the Payment was Taken By
AddExtra: Error 4 - Could not determine who the Payment was Taken By
AddExtra: Error 5 - Could not determine who the Payment was Taken By
AddExtra: Error 1 - The Extra was not added.
AddExtra: Error 2 - The Extra was not added.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
APIUserName:
APIPassword:
BookingID:
ItemCodeToAddToBooking:

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 /XMLAdditionalFunctions15.025.asmx HTTP/1.1
Host: api.ciirus.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://xml.ciirus.com/AddExtra"

<?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>
    <AddExtra xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <BookingID>int</BookingID>
      <ItemCodeToAddToBooking>string</ItemCodeToAddToBooking>
    </AddExtra>
  </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>
    <AddExtraResponse xmlns="http://xml.ciirus.com/">
      <AddExtraResult>
        <AddExtraObj>
          <ResponseMessage>string</ResponseMessage>
          <ErrorMsg>string</ErrorMsg>
          <ExtraID>int</ExtraID>
          <ExtraPrice>decimal</ExtraPrice>
        </AddExtraObj>
        <AddExtraObj>
          <ResponseMessage>string</ResponseMessage>
          <ErrorMsg>string</ErrorMsg>
          <ExtraID>int</ExtraID>
          <ExtraPrice>decimal</ExtraPrice>
        </AddExtraObj>
      </AddExtraResult>
    </AddExtraResponse>
  </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 /XMLAdditionalFunctions15.025.asmx HTTP/1.1
Host: api.ciirus.com
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>
    <AddExtra xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <BookingID>int</BookingID>
      <ItemCodeToAddToBooking>string</ItemCodeToAddToBooking>
    </AddExtra>
  </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>
    <AddExtraResponse xmlns="http://xml.ciirus.com/">
      <AddExtraResult>
        <AddExtraObj>
          <ResponseMessage>string</ResponseMessage>
          <ErrorMsg>string</ErrorMsg>
          <ExtraID>int</ExtraID>
          <ExtraPrice>decimal</ExtraPrice>
        </AddExtraObj>
        <AddExtraObj>
          <ResponseMessage>string</ResponseMessage>
          <ErrorMsg>string</ErrorMsg>
          <ExtraID>int</ExtraID>
          <ExtraPrice>decimal</ExtraPrice>
        </AddExtraObj>
      </AddExtraResult>
    </AddExtraResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /XMLAdditionalFunctions15.025.asmx/AddExtra?APIUserName=string&APIPassword=string&BookingID=string&ItemCodeToAddToBooking=string HTTP/1.1
Host: api.ciirus.com

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfAddExtraObj xmlns="http://xml.ciirus.com/">
  <AddExtraObj>
    <ResponseMessage>string</ResponseMessage>
    <ErrorMsg>string</ErrorMsg>
    <ExtraID>int</ExtraID>
    <ExtraPrice>decimal</ExtraPrice>
  </AddExtraObj>
  <AddExtraObj>
    <ResponseMessage>string</ResponseMessage>
    <ErrorMsg>string</ErrorMsg>
    <ExtraID>int</ExtraID>
    <ExtraPrice>decimal</ExtraPrice>
  </AddExtraObj>
</ArrayOfAddExtraObj>

HTTP POST

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

POST /XMLAdditionalFunctions15.025.asmx/AddExtra HTTP/1.1
Host: api.ciirus.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

APIUserName=string&APIPassword=string&BookingID=string&ItemCodeToAddToBooking=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfAddExtraObj xmlns="http://xml.ciirus.com/">
  <AddExtraObj>
    <ResponseMessage>string</ResponseMessage>
    <ErrorMsg>string</ErrorMsg>
    <ExtraID>int</ExtraID>
    <ExtraPrice>decimal</ExtraPrice>
  </AddExtraObj>
  <AddExtraObj>
    <ResponseMessage>string</ResponseMessage>
    <ErrorMsg>string</ErrorMsg>
    <ExtraID>int</ExtraID>
    <ExtraPrice>decimal</ExtraPrice>
  </AddExtraObj>
</ArrayOfAddExtraObj>