Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

The getRIFCS API provides access to the contents of the RDA Registry, a metadata repository which underpins the core infrastructure of Research Data Australia and the ARDC.

Using this API, you can perform complex search queries and retrieve the original RIF-CS XML, as received by ARDC from the data source.


ParameterDescriptionExample Usage
qThe q parameter is normally the main query for the request.All values of q must be URL-encoded. It is also recommended that string values are surrounded by quotes.By default, the field seperator is “OR” unless “AND” is explicitly specified (see example usage #4).

1. Matching all records (i.e. unrestricted search):
q=*:*2. Matching records based on a particular field:
q=class:(collection)3. Matching multiple field values (OR):
q=class:(collection OR party)4. Matching on multiple fields (AND):
q=class:(collection) AND group_search:("Monash")5. Wildcard searching on string fields:

See Indexed Fields for more options.

sortSorting can be done on any indexed field which only has single values. Sort can be either:desc or asc.Note: Fields which are indexed as string or integers are sortable. Other field types may produce unexpected results.1. Sort based on key in ascending order:
q=*:*&sort=key asc2. Sort based on update time in descending order (most recent first):
q=key:*:*&sort=update_timestamp desc

This parameter is used to paginate results from a query.When specified, it indicates the offset in the complete result set for where the set of returned documents should begin and end.By default, results start at0 with 10 rows displayed. That is, by default only 10 rows are displayed in response to a search query.1. Display the first 10 records with a key starting AODN:q=key:AODN*2. Display the next 10 records with a key starting AODN:q=key:AODN*&start=10


3. Display 100 records starting from number 1000: