ReliefWebAPI - the Ruby gem for the The ReliefWeb API
Interactive API documentation for the data API of Reliefweb.int. ReliefWeb is a leading source of information on global crises and disasters.
Our continuous coverage and archive going back to the 1970s makes ReliefWeb an unparalleled resource for both current and historical data on humanitarian response.
The vast majority of content on ReliefWeb has been contributed by humanitarian partners. We owe it to the community to make data more accessible and reusable, so that developers can build tools that increase exposure for valuable content and facilitate analysis for better decisions.
This SDK is automatically generated by the Swagger Codegen project:
Add this to the Gemfile:
gem 'reliefweb-api'
If the Ruby gem is hosted at a git repository: https://github.com/sriprasanna/reliefweb-api-ruby-client, then add the following in the Gemfile:
gem 'reliefweb-api', :git => 'https://github.com/sriprasanna/reliefweb-api-ruby-client.git'
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'reliefweb-api'
api_instance = ReliefWebAPI::CountriesApi.new
opts = {
query_value: 'query_value_example', # String | Specify the terms of your fuzzy search. The default is no query.
query_operator: 'query_operator_example', # String | Specify the operator by which your search query words will be combined.
query_fields: ['query_fields_example'], # Array<String> | Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.
filter_field: 'filter_field_example', # String | Field to filter by. Every condition must contain either a <code>field</code> or <code>conditions</code> property.
filter_value: ['filter_value_example'], # Array<String> | Value for the field being filtered. Leave blank to require existence of the field, must be present for <code>range</code> and <code>value</code> conditions.
filter_operator: 'filter_operator_example', # String | Operator by which filters will be combined.
filter_negate: true, # BOOLEAN | Reverse the filter to include those items that do not match.
filter_conditions: ['filter_conditions_example'], # Array<String> | This property is used to combine conditions with a logical connector (the <code>operator</code> property). Every condition must contain one of the <code>field</code> or <code>conditions</code> properties.
facets_field: 'facets_field_example', # String | Field to facet by. May include dates, references or the status field.
facets_name: 'facets_name_example', # String | Identifier for resulting facet data. Useful when faceting multiple ways on the same field.
facets_limit: 56, # Integer | Limit the number of facets returned for non-date based facets.
facets_sort: 'facets_sort_example', # String | The sort order of non-date facets. Sorting may be by <code>value</code> or <code>count</code> of terms, and ascending or descending. <code>count</code> defaults to <code>desc</code>, <code>value</code> defaults to <code>asc</code>.
facets_filter: ['facets_filter_example'], # Array<String> | Apply all the same capabilities of the filter parameter to the specific results of this facet request.
facets_interval: 'facets_interval_example', # String | Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request.
fields_include: ['fields_include_example'], # Array<String> | Specify which fields to include for each item. Defaults to an item label.
fields_exclude: ['fields_exclude_example'] # Array<String> | Specify sub-fields to exclude from overall results. For example, if you include <code>date</code> you may exclude <code>date.changed</code>.
limit: 10, # Integer | The maximum number of items to return for a list query. The default is <code>10</code> and the maximum <code>1000</code>.
offset: 0, # Integer | The offset from which to return the items in a list query. Allows paging through all results. The default is <code>0</code>.
sort: ['sort_example'], # Array<String> | Sort the list results. Defaults to search relevance. Values in the form of <code>fieldname:(asc|desc)</code>.
profile: 'profile_example', # String | Pre-built standard selections of fields to return for ease of displaying lists or items.
preset: 'preset_example' # String | Pre-built standard configurations of queries, filters and sorts for common use cases.
}
begin
#List or search countries covered by ReliefWeb.
result = api_instance.get_countries(opts)
p result
rescue ReliefWebAPI::ApiError => e
puts "Exception when calling CountriesApi->get_countries: #{e}"
end
All URIs are relative to https://api.reliefweb.int/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ReliefWebAPI::CountriesApi | get_countries | GET /countries | List or search countries covered by ReliefWeb. |
| ReliefWebAPI::CountriesApi | get_country_by_id | GET /countries/{countryId} | Find country by its unique ID |
| ReliefWebAPI::CountriesApi | search_countries | POST /countries | List or search countries covered by ReliefWeb. |
| ReliefWebAPI::DisastersApi | get_disaster_by_id | GET /disasters/{disasterId} | Find disaster by its unique ID |
| ReliefWebAPI::DisastersApi | get_disasters | GET /disasters | List or search disasters covered by ReliefWeb. |
| ReliefWebAPI::DisastersApi | search_disasters | POST /disasters | List or search disasters covered by ReliefWeb. |
| ReliefWebAPI::DiscoveryApi | discovery_resources | GET / | |
| ReliefWebAPI::DiscoveryApi | discovery_versions | GET /../ | |
| ReliefWebAPI::JobsApi | get_job_by_id | GET /jobs/{jobId} | Find job by its unique ID |
| ReliefWebAPI::JobsApi | get_jobs | GET /jobs | List or search humanitarian job offers. |
| ReliefWebAPI::JobsApi | search_jobs | POST /jobs | List or search humanitarian job offers. |
| ReliefWebAPI::ReportsApi | get_report_by_id | GET /reports/{reportId} | Find report by its unique ID |
| ReliefWebAPI::ReportsApi | get_reports | GET /reports | List or search updates, headlines or maps. |
| ReliefWebAPI::ReportsApi | search_reports | POST /reports | List or search updates, headlines or maps. |
| ReliefWebAPI::SourcesApi | get_source_by_id | GET /sources/{sourceId} | Find source by its unique ID |
| ReliefWebAPI::SourcesApi | get_sources | GET /sources | List or search organizations providing content to ReliefWeb. |
| ReliefWebAPI::SourcesApi | search_sources | POST /sources | List or search organizations providing content to ReliefWeb. |
| ReliefWebAPI::TrainingApi | get_training | GET /training | List or search humanitarian learning opportunities. |
| ReliefWebAPI::TrainingApi | get_training_by_id | GET /training/{trainingId} | Find training by its unique ID |
| ReliefWebAPI::TrainingApi | search_training | POST /training | List or search humanitarian learning opportunities. |
All endpoints do not require authorization.
FAQs
Unknown package
We found that reliefweb-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.