GetDocuments1

# GetDocuments1 API

Returns the documents in the specified infoRouter folder path in short form. This is a lightweight, high-performance variant of GetDocuments that uses abbreviated element names and a minimal attribute set. No optional enrichment flags are available — use GetDocuments when full document metadata (property sets, security, owner, versions) is required.

Endpoint¶

/srv.asmx/GetDocuments1

Methods¶

• GET /srv.asmx/GetDocuments1?AuthenticationTicket=...&Path=...
• POST /srv.asmx/GetDocuments1 (form data)
• SOAP Action: http://tempuri.org/GetDocuments1

Parameters¶

Response¶

Success Response¶

The root element is <response> and carries metadata about the queried folder as attributes. Each document in the folder is returned as a <d> child element using short, abbreviated attribute names. Sub-folder items are not included. If the folder exists but contains no documents, only the root element with folder metadata is returned.

<response success="true"
          error=""
          folderid="10"
          parentid="3"
          name="Reports"
          path="/Finance/Reports"
          folderfilter=""
          documentfilter=""
          itemcount="2">

  <d id="1051"
     n="Annual-Summary-2024.pdf"
     mdate="2024-06-15"
     cdate="2024-03-01"
     size="204800"
     dformat="PDF Document"
     chkoutbyusername=""
     chkoutbyfullname=""
     version="3"
     publishedversion="3"
     regdate="2024-03-01"
     dtype="0" />

  <d id="1052"
     n="Budget-2024.xlsx"
     mdate="2024-05-20"
     cdate="2024-01-10"
     size="98304"
     dformat="Microsoft Excel Spreadsheet"
     chkoutbyusername="jsmith"
     chkoutbyfullname="John Smith"
     version="2"
     publishedversion="0"
     regdate="2024-01-10"
     dtype="0" />

</response>

Root Element (<response>) Attributes¶

Document Element (<d>) Attributes¶

Error Response¶

<response success="false" error="[ErrorCode] Error message" />

Required Permissions¶

The calling user must have at least List permission on the specified folder. Documents to which the user has no access are automatically excluded from the response. Read-only users may call this API.

Example¶

GET Request¶

GET /srv.asmx/GetDocuments1
  ?AuthenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &Path=/Finance/Reports
HTTP/1.1

POST Request¶

POST /srv.asmx/GetDocuments1 HTTP/1.1
Content-Type: application/x-www-form-urlencoded

AuthenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301&Path=/Finance/Reports

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:GetDocuments1>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:Path>/Finance/Reports</tns:Path>
    </tns:GetDocuments1>
  </soap:Body>
</soap:Envelope>

Notes¶

• The listing is not recursive — only the immediate documents in the specified Path are returned. Sub-folder contents are not traversed.
• Sub-folder items are never included in the response. To retrieve both folders and documents in short form, use GetFoldersAndDocuments1.
• The root element is <response>, not <root>, which differs from most other infoRouter APIs. Parse the response accordingly.
• Document items use the abbreviated element name <d> and carry a minimal attribute set. To retrieve full document metadata, use GetDocument or GetDocuments.
• All documents are returned in a single response with no paging. For large folders, consider GetDocumentsByPage to page through results.
• The Path parameter is case-insensitive and leading/trailing slashes are normalized automatically.
• If the path does not exist or the user has no access to it, an error response is returned with success="false".
• Date fields use yyyy-MM-dd format.
• This API is significantly faster than GetDocuments for large folders because it avoids loading full document objects. Use it when only identity, name, size, date, or checkout status is needed.

Related APIs¶

• GetDocuments - Get full properties of every document in a folder path
• GetFoldersAndDocuments1 - Return both sub-folders and documents in short form
• GetDocumentsByPage - Get a paginated list of documents in a folder in short form
• GetDocument - Get the full properties of a single document by path
• GetFoldersAndDocuments - Full-detail listing with optional property sets, security, owner, and version history

Error Codes¶

For detailed documentation visit: https://support.inforouter.com/api-docs/GetDocuments1