GET /api/Assessments
Assessments

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Examples

GET /Assessments?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
403
GET /Assessments?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
[]
GET /Assessments?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
403

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.
start_date
optional

Start date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.
end_date
optional

End date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Assessment

Validations:

  • Must be String.
meta
required

Validations:

  • Must be String.
status
required

Validations:

  • Must be String.
code
required

Validations:

  • Must be Hash.
subject
required

Validations:

  • Must be Hash.
effective_date_time
required

Validations:

  • Must be String.