GET families - ocariot/api-gateway GitHub Wiki

Description

Returns a list with families.

Permissions:

• Only Admin users can list information of all families.

Scope

families:readAll

URL

GET https://localhost/v1/families

Curl example

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

Response body

• 200 Successful requisition.

  [
      {
          "id": "5a62be07de34500146d9c544",
          "username": "family01",
          "children": [
            {
              "id": "5a62be07de34500146d9c544",
              "username": "BR9999",
              "gender": "male",
              "age": 11,
              "institution_id": "5a62be07de34500146d9c624"
            }
          ],
          "institution_id": "5a62be07de34500146d9c624"
      }
  ]
  

• 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/families?username=*BR*

• Pagination

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

• Limitation

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

• Sorting

  https://localhost/v1/families?sort=username

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

https://localhost/v1/families?username=*BR*&sort=username&page=1&limit=10

For more details about using Query Strings click here.