Get Research Groups.md

Get Research Groups

Research Groups are a collection of WikiRate contributors, their Research Projects, and Metrics they created.

This example assumes you have configured your Wikirate REST client. Instructions on how to configure a client can be found in examples/Configurations.md

The get_research_groups method take as an input a Hash where the user can define the parameters of their request. More specifically, we could divide our params in two different types of parameters, the endpoint parameters and the filter parameters. The endpoint parameters help us to iterate through our query's results and the filter parameters allow us to restrict our results based on specific given input.

endpoint params:

• limit: default value 20, the maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.
• offset: default value 0, the (zero-based) offset of the first item in the collection to return

filter params:

• name: returns research groups that contain in their name the given string

In the example below, we are looking for research groups that contain in their name the string University of Nottingham.

research_groups = client.get_research_groups({ 'name' => 'University of Nottingham' })
puts research_groups