GET institutions - ocariot/api-gateway GitHub Wiki

Description

Returns a list with institutions.

Permissions:

• Admin, Educator, Health Professional, and Application users can list information from all Institutions.

Scope

institutions:readAll

URL

GET https://localhost/v1/institutions

Curl example

curl -X GET "https://localhost/v1/institutions" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response body

• 200 Successful requisition.

  [
    {
      "id": "5db32dcabec1431c51ae15fc",
      "type": "Institute of Scientific Research",
      "name": "NUTES/UEPB",
      "address": "Av. Juvêncio Arruda, S/N - Universitário, Campina Grande - PB, 58429-600",
      "latitude": "-7.2100766",
      "longitude": "-35.9175756"
    }
  ]
  

• 401 Unauthorized Error

• 403 Permission Error

• 429 Too Many Requests Error

• 500 Internal Server Error

Query Strings (Optional)

Query strings are used as follows: there must be a question mark following the URL and providing the parameters for the desired operations. There are four possible operations: filtering, paging, limiting, and sorting.

• Filtering

  https://localhost/v1/institutions?name=*BR*

• Pagination

  https://localhost/v1/institutions?page=1

• Limitation

  https://localhost/v1/institutions?limit=10

• Sorting

  https://localhost/v1/institutions?sort=name,type

All parameters can also be used together concatenated by the & character as follows:

https://localhost/v1/institutions?name=*BR*&sort=name,type&page=1&limit=10

For more details about using Query Strings click here.