GET institution by ID - ocariot/api-gateway GitHub Wiki

Description

Returns an unique institution by id.

Permissions:

• Admin, Educator, Health Professional, and Application users can list information from any institution.
• On the other hand, Child and Family users can only list information from the institution to which they belong.

Scope

institutions:read

URL

GET https://localhost/v1/institutions/{institution_id}

Parameters

institution_id: string (A 24-byte hex ID)

Curl example

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

Response body

• 200 Successful requisition.

  {
    "id": "5a62be07de34500146d9c544",
    "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"
  }
  

• 400 Validation errors

  • Invalid institution_id

• 401 Unauthorized Error

• 403 Permission Error

• 404 Not Found Error

• 429 Too Many Requests Error

• 500 Internal Server Error