List Public Records
Overview
This endpoint provides functionality to search and retrieve indexed documents using Apache Solr. Apache Solr is an open-source search platform built on Apache Lucene that offers powerful full-text search capabilities. This endpoint allows you to query the Solr index to find and access public records based on specified search criteria.
Endpoint
GET /api/v2013/index
Headers
The request must include the following headers:
| Field | Type | Description |
|---|---|---|
| Content-Type | String | Indicates the format of the data being sent in the request body. This header specifies the media type and encoding of the request payload. The allowed value is application/json, meaning that the request body is formatted as JSON. This helps the server understand how to parse and interpret the incoming data. |
| Realm | String | Defines the specific context or domain within which the Clearing-House request is being made. This header determines the environment or operational scope for the request. Allowed values include abs (Access and Benefit-sharing Clearing-House), chm (Central Clearing-House Mechanism), and bch (Biosafety Clearing-House). Each value represents a different area of functionality or service. |
| Accept | String | Specifies the format in which the client prefers to receive the response data. This header informs the server of the desired response format to ensure compatibility with the client’s data processing. The allowed value is application/json, indicating that the client expects the response to be formatted in JSON. This ensures the response data is structured in a way that the client can properly handle and interpret. |
Realm Values for Development:
abs-dev: Represents the development environment for ABS (Access and Benefit-sharing Clearing-House). Use this value when testing or developing features related to ABS in a non-production setting.bch-dev: Indicates the development environment for BCH (Biosafety Clearing-House). This value is used for testing or development purposes related to BCH functionalities.chm-dev: Specifies the development environment for CHM (Central Clearing-House Mechanism). This realm is used when working on features or testing in the CHM context within a development environment.
Query Parameters
The query parameters allow clients to filter and sort the search results based on specific criteria. Each parameter provides a way to customize the request to retrieve only the relevant documents. Refer to the Solr query syntax for more details.
| Field | Type | Description |
|---|---|---|
| q | String | The main query parameter used to search for documents. It specifies the search criteria and is the most crucial parameter. For detailed syntax, refer to the Solr query syntax. The detail breakdown is mentioned in the below table |
| fl | String | Fields to return in the search results. Use comma-separated field names to specify which fields should be included in the response. |
| sort | String | Specifies the sort order of the results. The format is fieldname desc for descending or fieldname asc for ascending. |
| start | String | The starting offset for the results. This parameter allows pagination by specifying the index of the first result to return. |
| rows | String | The number of results to return. Default value is 10 if not specified. |
Detailed Breakdown of q Parameter
The q parameter is used to define the search criteria in Solr queries. It can include several sub-parameters to filter and sort the results.
| Field | Type | Description |
|---|---|---|
| realm | String | The realm parameter specifies the realm of the documents to be searched. It filters results based on the realm value. Example: realm_ss:abs-dev. |
| schema | String | The schema parameter defines the schema to filter the documents. Example: schema_s:absPermit. |
| government | String | The government parameter filters documents based on the government ISO codes. Example: government_s:ht. The ISO codes can be received from the countries API. |
Playground
Swagger playground is loading, please wait...