GET child weight

Description

Retrieves a list with all weight measurements associated with a Child.

Permissions:

• Admin and Application users can list all Weight objects of any Child.

• A child can list all his weight objects.

• An Educator as well as a Health Professional can list all Weight objects of any Child as long as the Child belongs to one of their groups.

• A Family user can list all Weight objects of any Child associated with them.

Scope

measurements:read

URL

GET https://localhost/v1/children/{child_id}/weights

Parameters

child_id: string (A 24-byte hex ID)

Curl example

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

Response body

• 200 Successful requisition.

  [
      {
          "id": "5a62be07de34500146d9c544",
          "timestamp": "2019-06-20T14:40:00Z",
          "value": 70.2,
          "unit": "kg",
          "body_fat": 20.1,
          "child_id": "5a62be07de34500146d9c544"
      }
  ]

• 400 Validation errors

  • Invalid child id
  • Child does not exist

• 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/5a62be07d6f33400146c9b61/weights?value=gt:60

• Pagination

  https://localhost/v1/children/5a62be07d6f33400146c9b61/weights?page=1

• Limitation

  https://localhost/v1/children/5a62be07d6f33400146c9b61/weights?limit=20

• Sorting

  https://localhost/v1/children/5a62be07d6f33400146c9b61/weights?sort=value

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

https://localhost/v1/children/5a62be07d6f33400146c9b61/weights?value=gt:60&sort=value&page=1&limit=20

For more details about using Query Strings click here.