CiirusXMLAdditionalFunctions15025


Click here for a complete list of operations.

UserFunctions

This is a general purpose function for one off additions to the API. The documentation on how to use this function varies per user. This usage and purpose of this function will be determined via correspondence between CiiRUS developers and this integration third party developers. Documentation on this function is provided on a per User basis.
Note: You MUST URL encode the XML string passed in the xmlMsg input string field.



Pass the following parameters:

  • APIUsername (String)
  • APIPassword (String)
  • xmlMsg (String)
  • returnRequestingXML (Boolean)
    • Note:The parameter returnRequestingXML should be false at all times, unless you are debugging and would like to see what our server sees as your request. Your request XML will be returned in the nodes "<requestingXML>string</requestingXML>".



Error Responses:

  • Please check the error message in the response found at the nodes "<errorMessage>string</errorMessage>". If this error does not help, and the issue persists, please contact CiiRUS utilizing:
    Obtaining API Support


Valid Response:

  • This will be defined specific to the function developed specifically for your user.

Test

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

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

<?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>
    <UserFunctions xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <xmlMsg>string</xmlMsg>
      <returnRequestingXML>boolean</returnRequestingXML>
    </UserFunctions>
  </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>
    <UserFunctionsResponse xmlns="http://xml.ciirus.com/">
      <UserFunctionsResult>
        <requestingUserID>int</requestingUserID>
        <requestDateTime>dateTime</requestDateTime>
        <responseDateTime>dateTime</responseDateTime>
        <requestingIP>string</requestingIP>
        <errorMessage>string</errorMessage>
        <requestingXML>string</requestingXML>
        <stringResponse>string</stringResponse>
        <integerResponse>int</integerResponse>
        <decimalResponse>decimal</decimalResponse>
        <booleanResponse>boolean</booleanResponse>
        <datasetResponse>
          <xsd:schema>schema</xsd:schema>xml</datasetResponse>
        <ComplexRates>
          <ComplexRates>
            <PropertyID>int</PropertyID>
            <PropertyRates xsi:nil="true" />
            <ErrorMsg>string</ErrorMsg>
          </ComplexRates>
          <ComplexRates>
            <PropertyID>int</PropertyID>
            <PropertyRates xsi:nil="true" />
            <ErrorMsg>string</ErrorMsg>
          </ComplexRates>
        </ComplexRates>
      </UserFunctionsResult>
    </UserFunctionsResponse>
  </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>
    <UserFunctions xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <xmlMsg>string</xmlMsg>
      <returnRequestingXML>boolean</returnRequestingXML>
    </UserFunctions>
  </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>
    <UserFunctionsResponse xmlns="http://xml.ciirus.com/">
      <UserFunctionsResult>
        <requestingUserID>int</requestingUserID>
        <requestDateTime>dateTime</requestDateTime>
        <responseDateTime>dateTime</responseDateTime>
        <requestingIP>string</requestingIP>
        <errorMessage>string</errorMessage>
        <requestingXML>string</requestingXML>
        <stringResponse>string</stringResponse>
        <integerResponse>int</integerResponse>
        <decimalResponse>decimal</decimalResponse>
        <booleanResponse>boolean</booleanResponse>
        <datasetResponse>
          <xsd:schema>schema</xsd:schema>xml</datasetResponse>
        <ComplexRates>
          <ComplexRates>
            <PropertyID>int</PropertyID>
            <PropertyRates xsi:nil="true" />
            <ErrorMsg>string</ErrorMsg>
          </ComplexRates>
          <ComplexRates>
            <PropertyID>int</PropertyID>
            <PropertyRates xsi:nil="true" />
            <ErrorMsg>string</ErrorMsg>
          </ComplexRates>
        </ComplexRates>
      </UserFunctionsResult>
    </UserFunctionsResponse>
  </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/UserFunctions?APIUserName=string&APIPassword=string&xmlMsg=string&returnRequestingXML=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"?>
<UserFunctionResult xmlns="http://xml.ciirus.com/">
  <requestingUserID>int</requestingUserID>
  <requestDateTime>dateTime</requestDateTime>
  <responseDateTime>dateTime</responseDateTime>
  <requestingIP>string</requestingIP>
  <errorMessage>string</errorMessage>
  <requestingXML>string</requestingXML>
  <stringResponse>string</stringResponse>
  <integerResponse>int</integerResponse>
  <decimalResponse>decimal</decimalResponse>
  <booleanResponse>boolean</booleanResponse>
  <datasetResponse>
    <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</datasetResponse>
  <ComplexRates>
    <ComplexRates>
      <PropertyID>int</PropertyID>
      <PropertyRates>
        <ComplexRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ComplexRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </PropertyRates>
      <ErrorMsg>string</ErrorMsg>
    </ComplexRates>
    <ComplexRates>
      <PropertyID>int</PropertyID>
      <PropertyRates>
        <ComplexRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ComplexRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </PropertyRates>
      <ErrorMsg>string</ErrorMsg>
    </ComplexRates>
  </ComplexRates>
</UserFunctionResult>

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

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

<?xml version="1.0" encoding="utf-8"?>
<UserFunctionResult xmlns="http://xml.ciirus.com/">
  <requestingUserID>int</requestingUserID>
  <requestDateTime>dateTime</requestDateTime>
  <responseDateTime>dateTime</responseDateTime>
  <requestingIP>string</requestingIP>
  <errorMessage>string</errorMessage>
  <requestingXML>string</requestingXML>
  <stringResponse>string</stringResponse>
  <integerResponse>int</integerResponse>
  <decimalResponse>decimal</decimalResponse>
  <booleanResponse>boolean</booleanResponse>
  <datasetResponse>
    <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</datasetResponse>
  <ComplexRates>
    <ComplexRates>
      <PropertyID>int</PropertyID>
      <PropertyRates>
        <ComplexRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ComplexRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </PropertyRates>
      <ErrorMsg>string</ErrorMsg>
    </ComplexRates>
    <ComplexRates>
      <PropertyID>int</PropertyID>
      <PropertyRates>
        <ComplexRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ComplexRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </PropertyRates>
      <ErrorMsg>string</ErrorMsg>
    </ComplexRates>
  </ComplexRates>
</UserFunctionResult>