POST api/Records/Create

Add a new record from a wearable device

Request Information

URI Parameters

None.

Body Parameters

Record model

WearableRecordModel
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

AccountModel

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": "5556ef23-540c-48b6-a5bb-ce1c248fd890",
  "AccountID": "a1338f35-9098-4621-968d-5025307d7343",
  "RecordDate": "2023-05-22T19:09:23.6306983+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": "c36e1292-a461-46ee-9e4d-70e198dca803",
    "ExternalID": "sample string 2",
    "Name": "sample string 3",
    "DOB": "2023-05-22T19:09:23.6306983+00:00",
    "Gender": "sample string 4",
    "Devices": "sample string 5",
    "Country": "sample string 6",
    "Age": 1,
    "Location": "sample string 8",
    "Created": "2023-05-22T19:09:23.6306983+00:00",
    "HasDevices": true,
    "OrganisationName": "sample string 9"
  }
}

application/xml, text/xml

Sample:
<WearableRecordModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models.Records">
  <AccountID>a1338f35-9098-4621-968d-5025307d7343</AccountID>
  <Category>sample string 4</Category>
  <Data>sample string 9</Data>
  <Device>sample string 8</Device>
  <ID>5556ef23-540c-48b6-a5bb-ce1c248fd890</ID>
  <Reading>5</Reading>
  <RecordDate>2023-05-22T19:09:23.6306983+00:00</RecordDate>
  <SNOMEDCode>sample string 6</SNOMEDCode>
  <Title>sample string 10</Title>
  <Unit>sample string 7</Unit>
  <UserAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models.Accounts">
    <d2p1:Age>1</d2p1:Age>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:Created>2023-05-22T19:09:23.6306983+00:00</d2p1:Created>
    <d2p1:DOB>2023-05-22T19:09:23.6306983+00:00</d2p1:DOB>
    <d2p1:Devices>sample string 5</d2p1:Devices>
    <d2p1:ExternalID>sample string 2</d2p1:ExternalID>
    <d2p1:Gender>sample string 4</d2p1:Gender>
    <d2p1:HasDevices>true</d2p1:HasDevices>
    <d2p1:ID>c36e1292-a461-46ee-9e4d-70e198dca803</d2p1:ID>
    <d2p1:Location>sample string 8</d2p1:Location>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:OrganisationID>c83e49ce-8448-4a9d-8550-73114599a94e</d2p1:OrganisationID>
    <d2p1:OrganisationName>sample string 9</d2p1:OrganisationName>
  </UserAccount>
</WearableRecordModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Added record

WearableRecordModel
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

AccountModel

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": "2a6fd196-092d-45c1-9f48-a2807115cd5d",
  "AccountID": "c02201e0-e832-4bf6-bcf5-700bd7c3e5b1",
  "RecordDate": "2023-05-22T19:09:23.6463282+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": "06a29bdb-7e16-4ac2-b8f6-06c54d629b95",
    "ExternalID": "sample string 2",
    "Name": "sample string 3",
    "DOB": "2023-05-22T19:09:23.6463282+00:00",
    "Gender": "sample string 4",
    "Devices": "sample string 5",
    "Country": "sample string 6",
    "Age": 1,
    "Location": "sample string 8",
    "Created": "2023-05-22T19:09:23.6463282+00:00",
    "HasDevices": true,
    "OrganisationName": "sample string 9"
  }
}

application/xml, text/xml

Sample:
<WearableRecordModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models.Records">
  <AccountID>c02201e0-e832-4bf6-bcf5-700bd7c3e5b1</AccountID>
  <Category>sample string 4</Category>
  <Data>sample string 9</Data>
  <Device>sample string 8</Device>
  <ID>2a6fd196-092d-45c1-9f48-a2807115cd5d</ID>
  <Reading>5</Reading>
  <RecordDate>2023-05-22T19:09:23.6463282+00:00</RecordDate>
  <SNOMEDCode>sample string 6</SNOMEDCode>
  <Title>sample string 10</Title>
  <Unit>sample string 7</Unit>
  <UserAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models.Accounts">
    <d2p1:Age>1</d2p1:Age>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:Created>2023-05-22T19:09:23.6463282+00:00</d2p1:Created>
    <d2p1:DOB>2023-05-22T19:09:23.6463282+00:00</d2p1:DOB>
    <d2p1:Devices>sample string 5</d2p1:Devices>
    <d2p1:ExternalID>sample string 2</d2p1:ExternalID>
    <d2p1:Gender>sample string 4</d2p1:Gender>
    <d2p1:HasDevices>true</d2p1:HasDevices>
    <d2p1:ID>06a29bdb-7e16-4ac2-b8f6-06c54d629b95</d2p1:ID>
    <d2p1:Location>sample string 8</d2p1:Location>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:OrganisationID>b0703e98-8fb4-4d63-a320-d7a34fa692a4</d2p1:OrganisationID>
    <d2p1:OrganisationName>sample string 9</d2p1:OrganisationName>
  </UserAccount>
</WearableRecordModel>