Get a list of general assessments

GET /api/v1/general-assessments
Api key auth

Retrieve a list of general assessments associated with a specific patient, with optional sorting, pagination, and filtering. Note: Some upcoming changes are planned.

Path parameters

  • patient_id integer Required

    ID of the patient

Query parameters

  • per_page integer

    Number of items per page.

  • fields string(csv)

    Comma-separated list of fields to be returned in the response. Fields list will be available soon.

  • filter object

    Filter criteria to narrow down the list of general-assessments. The filter parameter is an object with key-value pairs where the key is the field to filter by and the value is '{operator}{value}'. The operator is optional and defaults to '='. (e.g. '/general-assessments?wound_id=3089&filter[date]=>=2021-01-01')

  • sort string

    Field to sort the results by. Only 'id' and 'created_at' columns are allowed, prefixed with a minus sign (-) for descending order and without for ascending order.

    Values are id, -id, created_at, or -created_at.

Responses

  • 200 application/json

    Successful operation

    Hide response attributes Show response attributes object
    • data array[object]
      Hide data attributes Show data attributes object
      • id integer
      • date string(date)

        Date the Assessment was performed

      • created_at string(date-time)

        Date and time the general assessment was created in the system (UTC time)

    • metadata object
      Hide metadata attributes Show metadata attributes object
      • current_page integer
      • last_page integer
      • per_page integer
      • total integer
      • next_page_url string
      • prev_page_url string
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • error string
    • message string
    • error_code number
  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • error string
    • message string
    • error_code number
  • 403 application/json

    Forbidden

    Hide response attributes Show response attributes object
    • error string
    • message string
    • error_code number
  • 422 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • error string
    • message string
    • error_code number
GET /api/v1/general-assessments 
curl \
 --request GET 'https://publicapi.ekareinc.com/api/v1/general-assessments' \
 --header "X-API-KEY: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "id": 1144,
      "date": "2021-01-01",
      "created_at": "2021-01-01 00:00:00"
    }
  ],
  "metadata": {
    "current_page": 1,
    "last_page": 55,
    "per_page": 2,
    "total": 110,
    "next_page_url": "https://publicapi.ekareinc.com/api/v1/general-assessments?wound_id=3089&page=2",
    "prev_page_url": "string"
  }
}
Response examples (401) 
{
  "error": "Invalid API token",
  "message": "Unauthorized. Please provide a valid API token.",
  "error_code": "100"
}
Response examples (404) 
{
  "error": "Wound Not Found",
  "message": "The wound with the specified ID was not found.",
  "error_code": "111"
}
Response examples (403) 
{
  "error": "Access denied",
  "message": "Forbidden. You do not have permission to access this resource.",
  "error_code": "101"
}
Response examples (422) 
{
  "error": "Bad Request",
  "message": "The given data was invalid.",
  "error_code": "102"
}