ULTICAB_WS Web Service

ULTICAB_WS

Click here for a complete list of operations.

GetDocument

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

<?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>
    <GetDocument xmlns="http://www.ulticabinet.com/">
      <session_id>string</session_id>
      <document_id>int</document_id>
      <include_urls>boolean</include_urls>
    </GetDocument>
  </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>
    <GetDocumentResponse xmlns="http://www.ulticabinet.com/">
      <GetDocumentResult>
        <PendingDigitalSignatureId>int</PendingDigitalSignatureId>
        <NumberOfNotes>int</NumberOfNotes>
        <IsPendingOCR>boolean</IsPendingOCR>
        <EntityId>int</EntityId>
        <ExtractedText>string</ExtractedText>
        <MD5CheckSum>string</MD5CheckSum>
        <S3Prefix>string</S3Prefix>
        <IsPendingProcessing>boolean</IsPendingProcessing>
        <IsPreviewable>boolean</IsPreviewable>
        <IsInS3>boolean</IsInS3>
        <FileName>string</FileName>
        <FileSize>long</FileSize>
        <SupportFilesSize>long</SupportFilesSize>
        <HasCustomData>boolean</HasCustomData>
        <FullStorageFolder>string</FullStorageFolder>
        <RelativeStorageFolder>string</RelativeStorageFolder>
        <IsPendingS3Upload>boolean</IsPendingS3Upload>
        <DocumentJpegUrls>
          <string>string</string>
          <string>string</string>
        </DocumentJpegUrls>
        <DocumentThumbnailUrls>
          <string>string</string>
          <string>string</string>
        </DocumentThumbnailUrls>
        <DocumentUrl>string</DocumentUrl>
        <LocationId>int</LocationId>
        <LocationName>string</LocationName>
        <HasPDF>boolean</HasPDF>
        <OwnerUserId>string</OwnerUserId>
        <AddedByUserName>string</AddedByUserName>
        <AddedByUserId>string</AddedByUserId>
        <IsEncrypted>boolean</IsEncrypted>
        <Id>int</Id>
        <ExternalId>string</ExternalId>
        <Title>string</Title>
        <Description>string</Description>
        <Modifiers>int</Modifiers>
        <AddedDate>dateTime</AddedDate>
        <DocumentDate>dateTime</DocumentDate>
        <FolderId>int</FolderId>
        <FolderName>string</FolderName>
        <OwnerId>int</OwnerId>
        <OwnerUserName>string</OwnerUserName>
        <SecurityLevel>int</SecurityLevel>
        <ExpirationDate>dateTime</ExpirationDate>
        <ContactId>int</ContactId>
        <ContactName>string</ContactName>
        <FormId>int</FormId>
        <FormName>string</FormName>
        <CategoryId>int</CategoryId>
        <CategoryName>string</CategoryName>
        <CabinetId>int</CabinetId>
        <CabinetName>string</CabinetName>
        <ActualFileName>string</ActualFileName>
        <IsPending>boolean</IsPending>
        <CustomXMLData>string</CustomXMLData>
        <Barcode>string</Barcode>
        <NumberOfPages>int</NumberOfPages>
        <AddedBy>int</AddedBy>
        <NumberOfAttachments>int</NumberOfAttachments>
        <ParentId>int</ParentId>
        <DepartmentId>int</DepartmentId>
        <DepartmentName>string</DepartmentName>
        <Revision>int</Revision>
        <IsLocked>boolean</IsLocked>
        <LockedBy>int</LockedBy>
        <LockedDate>dateTime</LockedDate>
        <ProcessDocumentId>int</ProcessDocumentId>
        <Source>string</Source>
        <IsMp3>boolean</IsMp3>
        <IsFlash>boolean</IsFlash>
      </GetDocumentResult>
    </GetDocumentResponse>
  </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>
    <GetDocument xmlns="http://www.ulticabinet.com/">
      <session_id>string</session_id>
      <document_id>int</document_id>
      <include_urls>boolean</include_urls>
    </GetDocument>
  </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>
    <GetDocumentResponse xmlns="http://www.ulticabinet.com/">
      <GetDocumentResult>
        <PendingDigitalSignatureId>int</PendingDigitalSignatureId>
        <NumberOfNotes>int</NumberOfNotes>
        <IsPendingOCR>boolean</IsPendingOCR>
        <EntityId>int</EntityId>
        <ExtractedText>string</ExtractedText>
        <MD5CheckSum>string</MD5CheckSum>
        <S3Prefix>string</S3Prefix>
        <IsPendingProcessing>boolean</IsPendingProcessing>
        <IsPreviewable>boolean</IsPreviewable>
        <IsInS3>boolean</IsInS3>
        <FileName>string</FileName>
        <FileSize>long</FileSize>
        <SupportFilesSize>long</SupportFilesSize>
        <HasCustomData>boolean</HasCustomData>
        <FullStorageFolder>string</FullStorageFolder>
        <RelativeStorageFolder>string</RelativeStorageFolder>
        <IsPendingS3Upload>boolean</IsPendingS3Upload>
        <DocumentJpegUrls>
          <string>string</string>
          <string>string</string>
        </DocumentJpegUrls>
        <DocumentThumbnailUrls>
          <string>string</string>
          <string>string</string>
        </DocumentThumbnailUrls>
        <DocumentUrl>string</DocumentUrl>
        <LocationId>int</LocationId>
        <LocationName>string</LocationName>
        <HasPDF>boolean</HasPDF>
        <OwnerUserId>string</OwnerUserId>
        <AddedByUserName>string</AddedByUserName>
        <AddedByUserId>string</AddedByUserId>
        <IsEncrypted>boolean</IsEncrypted>
        <Id>int</Id>
        <ExternalId>string</ExternalId>
        <Title>string</Title>
        <Description>string</Description>
        <Modifiers>int</Modifiers>
        <AddedDate>dateTime</AddedDate>
        <DocumentDate>dateTime</DocumentDate>
        <FolderId>int</FolderId>
        <FolderName>string</FolderName>
        <OwnerId>int</OwnerId>
        <OwnerUserName>string</OwnerUserName>
        <SecurityLevel>int</SecurityLevel>
        <ExpirationDate>dateTime</ExpirationDate>
        <ContactId>int</ContactId>
        <ContactName>string</ContactName>
        <FormId>int</FormId>
        <FormName>string</FormName>
        <CategoryId>int</CategoryId>
        <CategoryName>string</CategoryName>
        <CabinetId>int</CabinetId>
        <CabinetName>string</CabinetName>
        <ActualFileName>string</ActualFileName>
        <IsPending>boolean</IsPending>
        <CustomXMLData>string</CustomXMLData>
        <Barcode>string</Barcode>
        <NumberOfPages>int</NumberOfPages>
        <AddedBy>int</AddedBy>
        <NumberOfAttachments>int</NumberOfAttachments>
        <ParentId>int</ParentId>
        <DepartmentId>int</DepartmentId>
        <DepartmentName>string</DepartmentName>
        <Revision>int</Revision>
        <IsLocked>boolean</IsLocked>
        <LockedBy>int</LockedBy>
        <LockedDate>dateTime</LockedDate>
        <ProcessDocumentId>int</ProcessDocumentId>
        <Source>string</Source>
        <IsMp3>boolean</IsMp3>
        <IsFlash>boolean</IsFlash>
      </GetDocumentResult>
    </GetDocumentResponse>
  </soap12:Body>
</soap12:Envelope>