ULTICAB_WS

Click here for a complete list of operations.

GetDocumentFormByName

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

<?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>
    <GetDocumentFormByName xmlns="http://www.ulticabinet.com/">
      <session_id>string</session_id>
      <name>string</name>
    </GetDocumentFormByName>
  </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>
    <GetDocumentFormByNameResponse xmlns="http://www.ulticabinet.com/">
      <GetDocumentFormByNameResult>
        <Keywords>string</Keywords>
        <HasExtractionSteps>boolean</HasExtractionSteps>
        <DefaultFilingProfile>int</DefaultFilingProfile>
        <Id>int</Id>
        <Name>string</Name>
        <DefaultXml>string</DefaultXml>
        <DocumentTemplateId>int</DocumentTemplateId>
        <Deleted>boolean</Deleted>
        <DeletedDate>dateTime</DeletedDate>
        <DeletedBy>int</DeletedBy>
        <OcrAutoAssignContact>boolean</OcrAutoAssignContact>
        <OcrAutoCreateContact>boolean</OcrAutoCreateContact>
        <OcrContactIdUdf>int</OcrContactIdUdf>
        <OcrContactNameUdf>int</OcrContactNameUdf>
        <OcrContactAddressUdf>int</OcrContactAddressUdf>
        <OcrContactCityUdf>int</OcrContactCityUdf>
        <OcrContactStateUdf>int</OcrContactStateUdf>
        <OcrContactZipUdf>int</OcrContactZipUdf>
        <OcrContactCountryUdf>int</OcrContactCountryUdf>
        <OcrContactPhoneUdf>int</OcrContactPhoneUdf>
        <OcrContactFaxUdf>int</OcrContactFaxUdf>
        <OcrContactCompanyUdf>int</OcrContactCompanyUdf>
        <OcrContactEmailUdf>int</OcrContactEmailUdf>
        <OcrCategoryId>int</OcrCategoryId>
      </GetDocumentFormByNameResult>
    </GetDocumentFormByNameResponse>
  </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>
    <GetDocumentFormByName xmlns="http://www.ulticabinet.com/">
      <session_id>string</session_id>
      <name>string</name>
    </GetDocumentFormByName>
  </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>
    <GetDocumentFormByNameResponse xmlns="http://www.ulticabinet.com/">
      <GetDocumentFormByNameResult>
        <Keywords>string</Keywords>
        <HasExtractionSteps>boolean</HasExtractionSteps>
        <DefaultFilingProfile>int</DefaultFilingProfile>
        <Id>int</Id>
        <Name>string</Name>
        <DefaultXml>string</DefaultXml>
        <DocumentTemplateId>int</DocumentTemplateId>
        <Deleted>boolean</Deleted>
        <DeletedDate>dateTime</DeletedDate>
        <DeletedBy>int</DeletedBy>
        <OcrAutoAssignContact>boolean</OcrAutoAssignContact>
        <OcrAutoCreateContact>boolean</OcrAutoCreateContact>
        <OcrContactIdUdf>int</OcrContactIdUdf>
        <OcrContactNameUdf>int</OcrContactNameUdf>
        <OcrContactAddressUdf>int</OcrContactAddressUdf>
        <OcrContactCityUdf>int</OcrContactCityUdf>
        <OcrContactStateUdf>int</OcrContactStateUdf>
        <OcrContactZipUdf>int</OcrContactZipUdf>
        <OcrContactCountryUdf>int</OcrContactCountryUdf>
        <OcrContactPhoneUdf>int</OcrContactPhoneUdf>
        <OcrContactFaxUdf>int</OcrContactFaxUdf>
        <OcrContactCompanyUdf>int</OcrContactCompanyUdf>
        <OcrContactEmailUdf>int</OcrContactEmailUdf>
        <OcrCategoryId>int</OcrCategoryId>
      </GetDocumentFormByNameResult>
    </GetDocumentFormByNameResponse>
  </soap12:Body>
</soap12:Envelope>