ULTICAB_WS Web Service

ULTICAB_WS

Click here for a complete list of operations.

AddUserDefinedField

Test

The test form is only available for requests from the local machine.

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 /devel/ulticab_ws.asmx HTTP/1.1
Host: www.ulticabinet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.ulticabinet.com/AddUserDefinedField"

<?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>
    <AddUserDefinedField xmlns="http://www.ulticabinet.com/">
      <session_id>string</session_id>
      <name>string</name>
      <query_expression>string</query_expression>
      <form_id>int</form_id>
      <xpath>string</xpath>
      <regex>string</regex>
      <enforce_regex>boolean</enforce_regex>
      <perform_ocr>boolean</perform_ocr>
      <ocr_x>string</ocr_x>
      <ocr_y>string</ocr_y>
      <ocr_w>string</ocr_w>
      <ocr_h>string</ocr_h>
      <ocr_page_no>string</ocr_page_no>
      <ocr_strip_out_list>string</ocr_strip_out_list>
      <description>string</description>
      <data_type>string</data_type>
      <set_as_document_id>boolean</set_as_document_id>
      <set_as_document_title>boolean</set_as_document_title>
    </AddUserDefinedField>
  </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>
    <AddUserDefinedFieldResponse xmlns="http://www.ulticabinet.com/">
      <AddUserDefinedFieldResult>boolean</AddUserDefinedFieldResult>
    </AddUserDefinedFieldResponse>
  </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 /devel/ulticab_ws.asmx HTTP/1.1
Host: www.ulticabinet.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>
    <AddUserDefinedField xmlns="http://www.ulticabinet.com/">
      <session_id>string</session_id>
      <name>string</name>
      <query_expression>string</query_expression>
      <form_id>int</form_id>
      <xpath>string</xpath>
      <regex>string</regex>
      <enforce_regex>boolean</enforce_regex>
      <perform_ocr>boolean</perform_ocr>
      <ocr_x>string</ocr_x>
      <ocr_y>string</ocr_y>
      <ocr_w>string</ocr_w>
      <ocr_h>string</ocr_h>
      <ocr_page_no>string</ocr_page_no>
      <ocr_strip_out_list>string</ocr_strip_out_list>
      <description>string</description>
      <data_type>string</data_type>
      <set_as_document_id>boolean</set_as_document_id>
      <set_as_document_title>boolean</set_as_document_title>
    </AddUserDefinedField>
  </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>
    <AddUserDefinedFieldResponse xmlns="http://www.ulticabinet.com/">
      <AddUserDefinedFieldResult>boolean</AddUserDefinedFieldResult>
    </AddUserDefinedFieldResponse>
  </soap12:Body>
</soap12:Envelope>