CiirusXMLAdditionalFunctions15025


Click here for a complete list of operations.

AddLockBoxCode

This can be used to establish that your credentials work/your IP is accepted by the webservice/and that the webservice is not down.



Pass the following parameters:

  • APIUsername (String)
  • APIPassword (String)
  • BookingID (Integer)
  • LockBoxCode (string - Max 20 chars)



Error Responses:

  • AddLockBoxCode: Validation Error 1
  • AddLockBoxCode: Validation Error 2
  • AddLockBoxCode: Your API user is not permitted to AddLockBoxCode. Please contact CiiRUS Support.
  • AddLockBoxCode: The maximum length of a LockBoxCode is 20 chars.


Valid Response:

  • true (Boolean)

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
APIUserName:
APIPassword:
BookingID:
LockBoxCode:

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

<?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>
    <AddLockBoxCode xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <BookingID>int</BookingID>
      <LockBoxCode>string</LockBoxCode>
    </AddLockBoxCode>
  </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>
    <AddLockBoxCodeResponse xmlns="http://xml.ciirus.com/">
      <AddLockBoxCodeResult>boolean</AddLockBoxCodeResult>
    </AddLockBoxCodeResponse>
  </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>
    <AddLockBoxCode xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <BookingID>int</BookingID>
      <LockBoxCode>string</LockBoxCode>
    </AddLockBoxCode>
  </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>
    <AddLockBoxCodeResponse xmlns="http://xml.ciirus.com/">
      <AddLockBoxCodeResult>boolean</AddLockBoxCodeResult>
    </AddLockBoxCodeResponse>
  </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/AddLockBoxCode?APIUserName=string&APIPassword=string&BookingID=string&LockBoxCode=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"?>
<boolean xmlns="http://xml.ciirus.com/">boolean</boolean>

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

APIUserName=string&APIPassword=string&BookingID=string&LockBoxCode=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

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