World Bank Documents & Reports Connector

info@ismena.com

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

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.

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.

Supported Integration Action Points

searchDocuments: Retrieves a list of document records based on search terms, fields, date ranges, facets, pagination, and sorting.

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	Required: None Optional: format: Response format (string, enum: [json, xml], default: json, e.g., json). qterm: General search term for document fields like title, abstract, report number, project number, country, or region (string, e.g., "wind turbine"). display_title: Search term for document title (string, e.g., "wind energy"). count_exact: Exact match for country, supports multiple values separated by '^' (string, e.g., "Algeria^Brazil"). lang_exact: Exact match for language, supports multiple values separated by '^' (string, e.g., "English^French"). docty_exact: Exact match for document type (string, e.g., "Procurement Plan"). fl: Comma-separated list of fields to include in response (string, e.g., "docdt,count,volnb,docna,repnme,docty"). fct: Comma-separated list of fields for facet information (string, e.g., "count_exact,lang_exact"). rows: Number of records per page (integer, default: 10, e.g., 20). os: Starting record index for pagination (integer, default: 0, e.g., 40). strdate: Filter documents newer than this date (string, YYYY-MM-DD, e.g., "2018-01-01"). enddate: Filter documents older than this date (string, YYYY-MM-DD, e.g., "2018-03-30"). sort: Field to sort results by (string, e.g., "docdt"). order: Sort order (string, enum: [asc, desc], default: desc). pageLanguage: Language of the result display page (string, enum: [en, fr, es, zh, ar, ru], default: en).
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_WORLDBANK_BASE_URL environment variable (e.g., https://search.worldbank.org/api/v3).
Output	Successful: Returns a JSON or XML object with: result: Success status (string, e.g., "success"). records: Array of document records with fields like docid, display_title, url, docdt, count, volnb, totvolnb, docna, repnme, docty. facets: Object with facet information for specified fields (e.g., {"count_exact": ["Algeria", "Brazil"], "lang_exact": ["English", "French"]}). Failure: Returns error details (e.g., {"error": "Invalid query parameter"} for 400, {"error": "Resource not found"} for 404).
Workflow Example	Configure the connector with the base URL (https://search.worldbank.org/api/v3). Execute the searchDocuments action with qterm="wind turbine", format=json, rows=20, and fct=count_exact,lang_exact. Process the response to display document records or use facets for refined searches.

Workflow Creation with the Connector

Example Workflow: Document Search and Analysis

Search for Documents

Execute the searchDocuments action with qterm=”wind energy”, format=json, rows=20, and fct=count_exact,lang_exact to fetch relevant documents and facet data.
Process the response to display document records (e.g., titles, URLs) in a dashboard or interface.

Retrieve Specific Document Details

Execute the searchDocuments action with qterm=”123456″ (using a specific docid) and fl=docid,display_title,url,docdt,count,volnb,docna,repnme,docty to fetch detailed metadata for a single document.
Save the metadata for reporting or link to the document URL.

Explore Facet Data

Use the facet data (e.g., countries or languages) to populate filter options in a search interface.

Refine Search

Execute the searchDocuments action with refined parameters (e.g., count_exact=Algeria, strdate=2018-01-01, docty_exact=Procurement Plan) based on facet selections or user input.
Analyze the refined results for research, reporting, or data visualization purposes.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to IBM x iSolution Event