GET children - ocariot/api-gateway GitHub Wiki

Description

Returns a list with children.

Permissions:

• Admin, Educator, and Health Professional users can list information from all Child user.

Scope

children:readAll

URL

GET https://localhost/v1/children

Curl example

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

Response body

• 200 Successful requisition.

  [
      {
        "id": "5db1cf6c099ed31587a74cf4",
        "username": "BR99999",
        "institution_id": "5a62be07de34500146d9c624",
        "gender": "male",
        "age": 11
      }
  ]
  

• 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/children?username=BR* (string at the beginning of username) https://localhost/v1/children?username=*BR (string at end of username) https://localhost/v1/children?username=*BR* (string in the middle of username) https://localhost/v1/children?username=BR001 (exactly the same string in the username)

• Pagination

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

• Limitation

  https://localhost/v1/children?limit=100

• Sorting

  https://localhost/v1/children?sort=username,age

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

https://localhost/v1/children?username=*BR*&sort=username,age&page=1&limit=100

For more details about using Query Strings click here.