CiirusXML15025
Click here for a complete list of operations.
GetPropertiesToBeEnabled
Returns the Properties accessable to your API User for which you have not yet enabled to do business. Until these are enabled, they will NOT be bookable and will NOT display as active properteis.
Use this function to get properties relative to your API User that require action before you can view/book this inventory via any API or SuperSite configuration.
Note:
Pass the following parameters:
- APIUsername (String)
- APIPassword (String)
Error Responses:
- GetPropertiesToBeEnabled: Validation Error 1
- GetPropertiesToBeEnabled: DataSet Error 1
- GetPropertiesToBeEnabled: DataSet Error 2
- GetPropertiesToBeEnabled: DataSet Error 3
- GetPropertiesToBeEnabled: No Properties to be enabled at this time.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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 /CiirusXML.15.025.asmx HTTP/1.1
Host: api.ciirus.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://xml.ciirus.com/GetPropertiesToBeEnabled"
<?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>
<GetPropertiesToBeEnabled xmlns="http://xml.ciirus.com/">
<APIUsername>string</APIUsername>
<APIPassword>string</APIPassword>
</GetPropertiesToBeEnabled>
</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>
<GetPropertiesToBeEnabledResponse xmlns="http://xml.ciirus.com/">
<GetPropertiesToBeEnabledResult>
<int>int</int>
<int>int</int>
</GetPropertiesToBeEnabledResult>
</GetPropertiesToBeEnabledResponse>
</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 /CiirusXML.15.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>
<GetPropertiesToBeEnabled xmlns="http://xml.ciirus.com/">
<APIUsername>string</APIUsername>
<APIPassword>string</APIPassword>
</GetPropertiesToBeEnabled>
</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>
<GetPropertiesToBeEnabledResponse xmlns="http://xml.ciirus.com/">
<GetPropertiesToBeEnabledResult>
<int>int</int>
<int>int</int>
</GetPropertiesToBeEnabledResult>
</GetPropertiesToBeEnabledResponse>
</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 /CiirusXML.15.025.asmx/GetPropertiesToBeEnabled?APIUsername=string&APIPassword=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"?> <ArrayOfInt xmlns="http://xml.ciirus.com/"> <int>int</int> <int>int</int> </ArrayOfInt>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /CiirusXML.15.025.asmx/GetPropertiesToBeEnabled HTTP/1.1 Host: api.ciirus.com Content-Type: application/x-www-form-urlencoded Content-Length: length APIUsername=string&APIPassword=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfInt xmlns="http://xml.ciirus.com/"> <int>int</int> <int>int</int> </ArrayOfInt>