GET api/Accounts/Get/{id}

Get an account by id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID for the user account

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

AccountModel
NameDescriptionTypeAdditional information
ID

The ID for the user

globally unique identifier

None.

ExternalID

User's external ID

string

Required

Name

User's name

string

None.

DOB

User's date of birth

date

None.

Gender

User's gender

string

None.

Devices

User's devices

string

None.

Country

User's country

string

None.

Age

User's age

integer

None.

Location

User's location

string

None.

Created

Date user was added to the system

date

None.

HasDevices

Whether user has devices

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": "7de313a6-c597-4829-98e5-959d8c6dc779",
  "ExternalID": "sample string 2",
  "Name": "sample string 3",
  "DOB": "2022-11-13T15:48:56.4702579+00:00",
  "Gender": "sample string 4",
  "Devices": "sample string 5",
  "Country": "sample string 6",
  "Age": 1,
  "Location": "sample string 8",
  "Created": "2022-11-13T15:48:56.485871+00:00",
  "HasDevices": true
}

application/xml, text/xml

Sample:
<AccountModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models.Accounts">
  <Age>1</Age>
  <Country>sample string 6</Country>
  <Created>2022-11-13T15:48:56.485871+00:00</Created>
  <DOB>2022-11-13T15:48:56.4702579+00:00</DOB>
  <Devices>sample string 5</Devices>
  <ExternalID>sample string 2</ExternalID>
  <Gender>sample string 4</Gender>
  <HasDevices>true</HasDevices>
  <ID>7de313a6-c597-4829-98e5-959d8c6dc779</ID>
  <Location>sample string 8</Location>
  <Name>sample string 3</Name>
  <OrganisationID>418e007f-b943-429f-80d8-4a702bb35642</OrganisationID>
</AccountModel>