POST api/Records/Query

Fetch records for an organisation based on filter criteria

Request Information

URI Parameters

None.

Body Parameters

WearableDataRequest
NameDescriptionTypeAdditional information
DateFrom

Date From

string

None.

DateTo

Date To

string

None.

ExternalID

External ID of the user / account

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",
  "Category": "sample string 4",
  "Title": "sample string 5",
  "TextValue": "sample string 6",
  "NumericValue": 7.0,
  "ExcludeData": "sample string 8",
  "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">
  <Category>sample string 4</Category>
  <DateFrom>sample string 1</DateFrom>
  <DateTo>sample string 2</DateTo>
  <ExcludeData>sample string 8</ExcludeData>
  <ExternalID>sample string 3</ExternalID>
  <IncludeAccounts>true</IncludeAccounts>
  <NumericValue>7</NumericValue>
  <TextValue>sample string 6</TextValue>
  <Title>sample string 5</Title>
</WearableDataRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of WearableDataResponse
NameDescriptionTypeAdditional information
ID

Record ID

globally unique identifier

None.

AccountID

ID for the account

globally unique identifier

None.

RecordDate

Record Date

date

None.

Category

Record Category

string

None.

Reading

Reading value

decimal number

None.

SNOMEDCode

The SNOMED Code for the record

string

None.

Unit

Reading Unit

string

None.

Device

Device the data came from

string

None.

Data

Text data value

string

None.

Title

Record title

string

None.

UserAccount

Details of the account

AccountResponse

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": "e1157686-d80d-4a5e-ae4b-65636e3c3777",
    "AccountID": "3932cef1-8ce0-4ec3-966e-59efcb58ac24",
    "RecordDate": "2021-10-18T17:42:33.9870897+00:00",
    "Category": "sample string 4",
    "Reading": 5.0,
    "SNOMEDCode": "sample string 6",
    "Unit": "sample string 7",
    "Device": "sample string 8",
    "Data": "sample string 9",
    "Title": "sample string 10",
    "UserAccount": {
      "ExternalID": "sample string 1",
      "Created": "2021-10-18T17:42:33.9870897+00:00",
      "Country": "sample string 2",
      "Name": "sample string 3",
      "Age": "sample string 4",
      "Location": "sample string 5",
      "DateOfBirth": "sample string 6",
      "Gender": "sample string 7",
      "ID": "65e510bc-c150-4cf1-83aa-80980a3f116a"
    }
  },
  {
    "ID": "e1157686-d80d-4a5e-ae4b-65636e3c3777",
    "AccountID": "3932cef1-8ce0-4ec3-966e-59efcb58ac24",
    "RecordDate": "2021-10-18T17:42:33.9870897+00:00",
    "Category": "sample string 4",
    "Reading": 5.0,
    "SNOMEDCode": "sample string 6",
    "Unit": "sample string 7",
    "Device": "sample string 8",
    "Data": "sample string 9",
    "Title": "sample string 10",
    "UserAccount": {
      "ExternalID": "sample string 1",
      "Created": "2021-10-18T17:42:33.9870897+00:00",
      "Country": "sample string 2",
      "Name": "sample string 3",
      "Age": "sample string 4",
      "Location": "sample string 5",
      "DateOfBirth": "sample string 6",
      "Gender": "sample string 7",
      "ID": "65e510bc-c150-4cf1-83aa-80980a3f116a"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfWearableDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models">
  <WearableDataResponse>
    <AccountID>3932cef1-8ce0-4ec3-966e-59efcb58ac24</AccountID>
    <Category>sample string 4</Category>
    <Data>sample string 9</Data>
    <Device>sample string 8</Device>
    <ID>e1157686-d80d-4a5e-ae4b-65636e3c3777</ID>
    <Reading>5</Reading>
    <RecordDate>2021-10-18T17:42:33.9870897+00:00</RecordDate>
    <SNOMEDCode>sample string 6</SNOMEDCode>
    <Title>sample string 10</Title>
    <Unit>sample string 7</Unit>
    <UserAccount>
      <Age>sample string 4</Age>
      <Country>sample string 2</Country>
      <Created>2021-10-18T17:42:33.9870897+00:00</Created>
      <DateOfBirth>sample string 6</DateOfBirth>
      <ExternalID>sample string 1</ExternalID>
      <Gender>sample string 7</Gender>
      <ID>65e510bc-c150-4cf1-83aa-80980a3f116a</ID>
      <Location>sample string 5</Location>
      <Name>sample string 3</Name>
    </UserAccount>
  </WearableDataResponse>
  <WearableDataResponse>
    <AccountID>3932cef1-8ce0-4ec3-966e-59efcb58ac24</AccountID>
    <Category>sample string 4</Category>
    <Data>sample string 9</Data>
    <Device>sample string 8</Device>
    <ID>e1157686-d80d-4a5e-ae4b-65636e3c3777</ID>
    <Reading>5</Reading>
    <RecordDate>2021-10-18T17:42:33.9870897+00:00</RecordDate>
    <SNOMEDCode>sample string 6</SNOMEDCode>
    <Title>sample string 10</Title>
    <Unit>sample string 7</Unit>
    <UserAccount>
      <Age>sample string 4</Age>
      <Country>sample string 2</Country>
      <Created>2021-10-18T17:42:33.9870897+00:00</Created>
      <DateOfBirth>sample string 6</DateOfBirth>
      <ExternalID>sample string 1</ExternalID>
      <Gender>sample string 7</Gender>
      <ID>65e510bc-c150-4cf1-83aa-80980a3f116a</ID>
      <Location>sample string 5</Location>
      <Name>sample string 3</Name>
    </UserAccount>
  </WearableDataResponse>
</ArrayOfWearableDataResponse>