POST api/Records/Percentage
Fetch percentage reported data for a particular field based on filter criteria
Request Information
URI Parameters
None.
Body Parameters
Data request model
WearableDataRequestName | Description | Type | Additional information |
---|---|---|---|
DateFrom |
Date From |
string |
None. |
DateTo |
Date To |
string |
None. |
ExternalID |
External ID of the user / account |
string |
None. |
AccountID | string |
None. |
|
Category |
Record Category |
string |
None. |
Title |
Record Title |
string |
None. |
TextValue |
Text Value Filter |
string |
None. |
NumericValue |
Numeric Value Filter |
decimal number |
None. |
ExcludeData |
Exclude any data (requires a title to be defined) |
string |
None. |
IncludeAccounts |
Whether or not to include account data in the return data |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "DateFrom": "sample string 1", "DateTo": "sample string 2", "ExternalID": "sample string 3", "AccountID": "sample string 4", "Category": "sample string 5", "Title": "sample string 6", "TextValue": "sample string 7", "NumericValue": 8.0, "ExcludeData": "sample string 9", "IncludeAccounts": true }
application/xml, text/xml
Sample:
<WearableDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models.Records"> <AccountID>sample string 4</AccountID> <Category>sample string 5</Category> <DateFrom>sample string 1</DateFrom> <DateTo>sample string 2</DateTo> <ExcludeData>sample string 9</ExcludeData> <ExternalID>sample string 3</ExternalID> <IncludeAccounts>true</IncludeAccounts> <NumericValue>8</NumericValue> <TextValue>sample string 7</TextValue> <Title>sample string 6</Title> </WearableDataRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
integerResponse Formats
application/json, text/json
Sample:
1
application/xml, text/xml
Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>