CiirusXMLAdditionalFunctions15025


Click here for a complete list of operations.

AddGuestReviews

This can be used to add Guest Review to the specified PropertyID



Pass the following parameters:

  • APIUsername (String)
  • APIPassword (String)
  • PropertyID (Integer)
  • FullGuestName (String)
  • GuestEmail (String)
  • StarRating (decimal)
  • GuestReview (String)
  • ShowGuestName (Boolean)



Error Responses:

  • AddGuestReviews: Validation Error 1
  • AddGuestReviews: Validation Error 2
  • AddGuestReviews: You must enter a valid PropertyID.
  • AddGuestReviews: Invalid e-mail address.
  • AddGuestReviews: The StarRating must be with in the range 0-5.
  • AddGuestReviews: Error - The Guest review was not added.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
APIUserName:
APIPassword:
PropertyID:
FullGuestName:
GuestEmail:
StarRating:
GuestReview:
ShowGuestName:

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/AddGuestReviews"

<?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>
    <AddGuestReviews xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
      <FullGuestName>string</FullGuestName>
      <GuestEmail>string</GuestEmail>
      <StarRating>decimal</StarRating>
      <GuestReview>string</GuestReview>
      <ShowGuestName>boolean</ShowGuestName>
    </AddGuestReviews>
  </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>
    <AddGuestReviewsResponse xmlns="http://xml.ciirus.com/">
      <AddGuestReviewsResult>string</AddGuestReviewsResult>
    </AddGuestReviewsResponse>
  </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>
    <AddGuestReviews xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
      <FullGuestName>string</FullGuestName>
      <GuestEmail>string</GuestEmail>
      <StarRating>decimal</StarRating>
      <GuestReview>string</GuestReview>
      <ShowGuestName>boolean</ShowGuestName>
    </AddGuestReviews>
  </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>
    <AddGuestReviewsResponse xmlns="http://xml.ciirus.com/">
      <AddGuestReviewsResult>string</AddGuestReviewsResult>
    </AddGuestReviewsResponse>
  </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/AddGuestReviews?APIUserName=string&APIPassword=string&PropertyID=string&FullGuestName=string&GuestEmail=string&StarRating=string&GuestReview=string&ShowGuestName=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"?>
<string xmlns="http://xml.ciirus.com/">string</string>

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/AddGuestReviews HTTP/1.1
Host: api.ciirus.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

APIUserName=string&APIPassword=string&PropertyID=string&FullGuestName=string&GuestEmail=string&StarRating=string&GuestReview=string&ShowGuestName=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://xml.ciirus.com/">string</string>