Custom Connector
World Bank Documents & Reports
KSA
The World Bank Documents & Reports Connector provides seamless integration with the World Bank Documents & Reports API, enabling access to public documents and reports. This connector acts as a proxy to streamline data retrieval, supporting a single action point for searching documents with flexible query parameters to filter, sort, and paginate results.
Overview
Integration Overview
This document provides a detailed guide for the searchDocuments action point, its purpose, configuration, and workflow support using the World Bank Documents & Reports Connector.
- searchDocuments. Retrieves a list of document records based on search terms, fields, date ranges, facets, pagination, and sorting.
Documentation
Detailed Integration Documentation
Document Search
| Action | searchDocuments |
|---|---|
| Purpose | Retrieves a list of document records matching the provided query parameters, supporting filtering by search terms, specific fields, date ranges, facets, pagination, and sorting. This is the primary entry point for accessing document data, including detailed metadata and facet information. |
| Parameters | Optional: format: Response format (json or xml, default json). qterm: General search term across title, abstract, report/project number, country, or region. display_title: Search term for document title. count_exact: Exact country match (multiple separated by '^'). lang_exact: Exact language match. docty_exact: Exact document type. fl: Comma-separated fields to include. fct: Comma-separated facet fields. rows: Records per page (default 10). os: Starting record index. strdate / enddate: Date range (YYYY-MM-DD). sort / order: Sort field and direction (asc/desc). pageLanguage: Result page language (en, fr, es, zh, ar, ru). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_WORLDBANK_BASE_URL (e.g. https://search.worldbank.org/api/v3). |
| Output | Successful: JSON or XML with result status, a records array (docid, display_title, url, docdt, count, volnb, docna, repnme, docty), and facets. Failure: error details (400 invalid parameter, 404 resource not found). |
| Workflow example | Configure the base URL, execute searchDocuments with qterm=“wind turbine”, format=json, rows=20, fct=count_exact,lang_exact, then process the response to display records or refine searches via facets. |
Example Workflow: Document Search and Analysis
| Search for documents | Execute searchDocuments with qterm=“wind energy”, rows=20, fct=count_exact,lang_exact to fetch relevant documents and facet data, then display records in a dashboard. |
|---|---|
| Retrieve document details | Execute searchDocuments with a specific docid and fl=docid,display_title,url,docdt,count,volnb,docna,repnme,docty to fetch detailed metadata for a single document. |
| Explore facet data | Execute searchDocuments with fct=count_exact,lang_exact to fetch facet data and populate filter options in a search interface. |
| Refine search | Execute searchDocuments with refined parameters (count_exact=Algeria, strdate=2018-01-01, docty_exact=Procurement Plan) based on facet selections or user input. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.