Get Fitness Assessment List

Description

This endpoint allows you to retrieve fitness assessments registered in the system, with filtering options by branch, creation period, validity period, expiration status, member, employee, protocol, and fitness assessment type.

NOTE. This endpoint is available exclusively for use with a General Admin access key.

NOTE. When the idProtocol parameter is provided, assessments of type 4 (Skinfolds) will not be included in the results, as this assessment type does not have a custom protocol.

🔑 Query Parameters

Parameter	Type	Required	Description
`idBranch`	array[int32]	No	List of branch identifiers used to filter the assessments.
`createdDateStart`	string (date-time)	No	Start date and time of the assessment creation period.
`createdDateEnd`	string (date-time)	No	End date and time of the assessment creation period.
`expiryDateStart`	string (date-time)	No	Start date and time of the assessment expiration period.
`expiryDateEnd`	string (date-time)	No	End date and time of the assessment expiration period.
`expired`	boolean	No	Filters assessments according to their expiration status.
`idMember`	int32	No	Filters by the identifier of a specific member.
`idEmployee`	int32	No	Filters by the identifier of a specific employee.
`idProtocol`	int32	No	Filters by the identifier of a specific protocol. When provided, assessments of type `4` (Skinfolds) are excluded from the results.
`type`	int32	No	Filters by fitness assessment type.
`take`	int32	No	Maximum number of records to be returned. Default: `200`.
`skip`	int32	No	Number of records to skip before returning the results. Default: `0`.

🔷 Assessment Types

The type parameter allows assessments to be filtered according to their type:

Code	Type
`1`	Anamnesis
`2`	Bioimpedance
`3`	Circumferences
`4`	Skinfolds

📤 Response Structure

The response returns a list of fitness assessments containing the main identification data, the employee responsible for the assessment, dates, and assessment type.

Field	Type	Description
`idFitnessAssessment`	int32	Unique identifier of the fitness assessment.
`idProtocol`	int32	Identifier of the protocol used in the fitness assessment.
`idMember`	int32	Identifier of the assessed member.
`nameMember`	string	Name of the assessed member.
`dateCreated`	date-time	Date and time when the fitness assessment was created.
`idEmployee`	int32	Identifier of the employee responsible for the assessment.
`nameEmployee`	string	Name of the employee responsible for the assessment.
`expiryDate`	date-time	Expiration date and time of the fitness assessment.
`editedDate`	date-time	Date and time of the last edit to the fitness assessment.
`type`	int32	Fitness assessment type.
`nameType`	string	Name of the fitness assessment type.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Success

Body

Example

[
    {
        "idFitnessAssessment": 0,
        "idProtocol": 0,
        "idMember": 0,
        "nameMember": "string",
        "dateCreated": "2019-08-24T14:15:22.123Z",
        "idEmployee": 0,
        "nameEmployee": "string",
        "expiryDate": "2019-08-24T14:15:22.123Z",
        "editedDate": "2019-08-24T14:15:22.123Z",
        "type": 0,
        "nameType": "string"
    }
]

🟠400

Management listing of fitness assessments by period/type/expiration (RF-3). General administration only.

Get Fitness Assessment List#

Description#

🔑 Query Parameters#

🔷 Assessment Types#

📤 Response Structure#