Veetro Web Service Methods Web Service

Veetro Web Service Methods

Click here for a complete list of operations.

GetDocumentSearchResults

[Permission: Employee, Credentials: Documents.Files.ViewFull/Limited]
Returns information on documents.

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 /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/GetDocumentSearchResults"

<?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>
    <GetDocumentSearchResults xmlns="http://schema.veetro.com">
      <e>
        <StartIndex>int</StartIndex>
        <FetchSize>int</FetchSize>
        <SortColumn>DocumentID or Name or DateCreated or DateModified</SortColumn>
        <Ascending>boolean</Ascending>
        <Keywords>string</Keywords>
        <FolderID>int</FolderID>
        <FromDateModifiedUtc>dateTime</FromDateModifiedUtc>
        <FromDateCreatedUtc>dateTime</FromDateCreatedUtc>
      </e>
    </GetDocumentSearchResults>
  </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>
    <GetDocumentSearchResultsResponse xmlns="http://schema.veetro.com">
      <GetDocumentSearchResultsResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <Document>
            <DocumentID>int</DocumentID>
            <Guid>guid</Guid>
            <DocumentID_LinkedFrom>int</DocumentID_LinkedFrom>
            <Data>base64Binary</Data>
            <Base64String>string</Base64String>
            <Name>string</Name>
            <DescriptionHtml>string</DescriptionHtml>
            <ParsedDesHtml>string</ParsedDesHtml>
            <ParsedDesPlain>string</ParsedDesPlain>
            <DateParseDesHtml>dateTime</DateParseDesHtml>
            <Extension>string</Extension>
            <EntryID>int</EntryID>
            <LeadID>int</LeadID>
            <InvoiceID>int</InvoiceID>
            <Flags>None or VeetroNotificationImage or IndirectDocument or FromEmail or FromDiscussion or FromComment or IsCompanyConfidential</Flags>
            <MIMEType>string</MIMEType>
            <Length>int</Length>
            <RemoteSize>long</RemoteSize>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
            <Owner xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Folder xsi:nil="true" />
            <Delete>boolean</Delete>
          </Document>
          <Document>
            <DocumentID>int</DocumentID>
            <Guid>guid</Guid>
            <DocumentID_LinkedFrom>int</DocumentID_LinkedFrom>
            <Data>base64Binary</Data>
            <Base64String>string</Base64String>
            <Name>string</Name>
            <DescriptionHtml>string</DescriptionHtml>
            <ParsedDesHtml>string</ParsedDesHtml>
            <ParsedDesPlain>string</ParsedDesPlain>
            <DateParseDesHtml>dateTime</DateParseDesHtml>
            <Extension>string</Extension>
            <EntryID>int</EntryID>
            <LeadID>int</LeadID>
            <InvoiceID>int</InvoiceID>
            <Flags>None or VeetroNotificationImage or IndirectDocument or FromEmail or FromDiscussion or FromComment or IsCompanyConfidential</Flags>
            <MIMEType>string</MIMEType>
            <Length>int</Length>
            <RemoteSize>long</RemoteSize>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
            <Owner xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Folder xsi:nil="true" />
            <Delete>boolean</Delete>
          </Document>
        </Results>
      </GetDocumentSearchResultsResult>
    </GetDocumentSearchResultsResponse>
  </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 /xml HTTP/1.1
Host: admin.worketc.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>
    <GetDocumentSearchResults xmlns="http://schema.veetro.com">
      <e>
        <StartIndex>int</StartIndex>
        <FetchSize>int</FetchSize>
        <SortColumn>DocumentID or Name or DateCreated or DateModified</SortColumn>
        <Ascending>boolean</Ascending>
        <Keywords>string</Keywords>
        <FolderID>int</FolderID>
        <FromDateModifiedUtc>dateTime</FromDateModifiedUtc>
        <FromDateCreatedUtc>dateTime</FromDateCreatedUtc>
      </e>
    </GetDocumentSearchResults>
  </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>
    <GetDocumentSearchResultsResponse xmlns="http://schema.veetro.com">
      <GetDocumentSearchResultsResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <Document>
            <DocumentID>int</DocumentID>
            <Guid>guid</Guid>
            <DocumentID_LinkedFrom>int</DocumentID_LinkedFrom>
            <Data>base64Binary</Data>
            <Base64String>string</Base64String>
            <Name>string</Name>
            <DescriptionHtml>string</DescriptionHtml>
            <ParsedDesHtml>string</ParsedDesHtml>
            <ParsedDesPlain>string</ParsedDesPlain>
            <DateParseDesHtml>dateTime</DateParseDesHtml>
            <Extension>string</Extension>
            <EntryID>int</EntryID>
            <LeadID>int</LeadID>
            <InvoiceID>int</InvoiceID>
            <Flags>None or VeetroNotificationImage or IndirectDocument or FromEmail or FromDiscussion or FromComment or IsCompanyConfidential</Flags>
            <MIMEType>string</MIMEType>
            <Length>int</Length>
            <RemoteSize>long</RemoteSize>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
            <Owner xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Folder xsi:nil="true" />
            <Delete>boolean</Delete>
          </Document>
          <Document>
            <DocumentID>int</DocumentID>
            <Guid>guid</Guid>
            <DocumentID_LinkedFrom>int</DocumentID_LinkedFrom>
            <Data>base64Binary</Data>
            <Base64String>string</Base64String>
            <Name>string</Name>
            <DescriptionHtml>string</DescriptionHtml>
            <ParsedDesHtml>string</ParsedDesHtml>
            <ParsedDesPlain>string</ParsedDesPlain>
            <DateParseDesHtml>dateTime</DateParseDesHtml>
            <Extension>string</Extension>
            <EntryID>int</EntryID>
            <LeadID>int</LeadID>
            <InvoiceID>int</InvoiceID>
            <Flags>None or VeetroNotificationImage or IndirectDocument or FromEmail or FromDiscussion or FromComment or IsCompanyConfidential</Flags>
            <MIMEType>string</MIMEType>
            <Length>int</Length>
            <RemoteSize>long</RemoteSize>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
            <Owner xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Folder xsi:nil="true" />
            <Delete>boolean</Delete>
          </Document>
        </Results>
      </GetDocumentSearchResultsResult>
    </GetDocumentSearchResultsResponse>
  </soap12:Body>
</soap12:Envelope>