POST api/Records/Query

Fetch records for an organisation based on filter criteria

Request Information

URI Parameters

None.

Body Parameters

Data request model

Name	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

Collection of WearableDataResponse

Name	Description	Type	Additional 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	AccountDataResponse	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": "d8337f62-9973-47e7-a698-86f0c89b7901",
    "AccountID": "30537cd6-c2c0-4740-a49b-9b0323567d7a",
    "RecordDate": "2024-04-25T06:39:37.0427343+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": {
      "ID": "c9186c85-ead4-4e8b-aac3-472536e6c17f",
      "ExternalID": "sample string 2",
      "Created": "2024-04-25T06:39:37.0427343+00:00",
      "Country": "sample string 3",
      "Name": "sample string 4",
      "Age": "sample string 5",
      "Location": "sample string 6",
      "DateOfBirth": "sample string 7",
      "Gender": "sample string 8"
    }
  },
  {
    "ID": "d8337f62-9973-47e7-a698-86f0c89b7901",
    "AccountID": "30537cd6-c2c0-4740-a49b-9b0323567d7a",
    "RecordDate": "2024-04-25T06:39:37.0427343+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": {
      "ID": "c9186c85-ead4-4e8b-aac3-472536e6c17f",
      "ExternalID": "sample string 2",
      "Created": "2024-04-25T06:39:37.0427343+00:00",
      "Country": "sample string 3",
      "Name": "sample string 4",
      "Age": "sample string 5",
      "Location": "sample string 6",
      "DateOfBirth": "sample string 7",
      "Gender": "sample string 8"
    }
  }
]

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.Records">
  <WearableDataResponse>
    <AccountID>30537cd6-c2c0-4740-a49b-9b0323567d7a</AccountID>
    <Category>sample string 4</Category>
    <Data>sample string 9</Data>
    <Device>sample string 8</Device>
    <ID>d8337f62-9973-47e7-a698-86f0c89b7901</ID>
    <Reading>5</Reading>
    <RecordDate>2024-04-25T06:39:37.0427343+00:00</RecordDate>
    <SNOMEDCode>sample string 6</SNOMEDCode>
    <Title>sample string 10</Title>
    <Unit>sample string 7</Unit>
    <UserAccount xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models.Accounts">
      <d3p1:Age>sample string 5</d3p1:Age>
      <d3p1:Country>sample string 3</d3p1:Country>
      <d3p1:Created>2024-04-25T06:39:37.0427343+00:00</d3p1:Created>
      <d3p1:DateOfBirth>sample string 7</d3p1:DateOfBirth>
      <d3p1:ExternalID>sample string 2</d3p1:ExternalID>
      <d3p1:Gender>sample string 8</d3p1:Gender>
      <d3p1:ID>c9186c85-ead4-4e8b-aac3-472536e6c17f</d3p1:ID>
      <d3p1:Location>sample string 6</d3p1:Location>
      <d3p1:Name>sample string 4</d3p1:Name>
    </UserAccount>
  </WearableDataResponse>
  <WearableDataResponse>
    <AccountID>30537cd6-c2c0-4740-a49b-9b0323567d7a</AccountID>
    <Category>sample string 4</Category>
    <Data>sample string 9</Data>
    <Device>sample string 8</Device>
    <ID>d8337f62-9973-47e7-a698-86f0c89b7901</ID>
    <Reading>5</Reading>
    <RecordDate>2024-04-25T06:39:37.0427343+00:00</RecordDate>
    <SNOMEDCode>sample string 6</SNOMEDCode>
    <Title>sample string 10</Title>
    <Unit>sample string 7</Unit>
    <UserAccount xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models.Accounts">
      <d3p1:Age>sample string 5</d3p1:Age>
      <d3p1:Country>sample string 3</d3p1:Country>
      <d3p1:Created>2024-04-25T06:39:37.0427343+00:00</d3p1:Created>
      <d3p1:DateOfBirth>sample string 7</d3p1:DateOfBirth>
      <d3p1:ExternalID>sample string 2</d3p1:ExternalID>
      <d3p1:Gender>sample string 8</d3p1:Gender>
      <d3p1:ID>c9186c85-ead4-4e8b-aac3-472536e6c17f</d3p1:ID>
      <d3p1:Location>sample string 6</d3p1:Location>
      <d3p1:Name>sample string 4</d3p1:Name>
    </UserAccount>
  </WearableDataResponse>
</ArrayOfWearableDataResponse>