POST api/Accounts/Fetch

Get a count of the number of accounts for the Organisation

Request Information

URI Parameters

None.

Body Parameters

AccountDataRequest
NameDescriptionTypeAdditional information
Name

Name of the user

string

None.

DateCreatedFrom

Date From

string

None.

DateCreatedTo

Date To

string

None.

Country

User's Country

string

None.

ExternalID

User's External ID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "DateCreatedFrom": "sample string 2",
  "DateCreatedTo": "sample string 3",
  "Country": "sample string 4",
  "ExternalID": "sample string 5"
}

application/xml, text/xml

Sample:
<AccountDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models">
  <Country>sample string 4</Country>
  <DateCreatedFrom>sample string 2</DateCreatedFrom>
  <DateCreatedTo>sample string 3</DateCreatedTo>
  <ExternalID>sample string 5</ExternalID>
  <Name>sample string 1</Name>
</AccountDataRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of AccountResponse
NameDescriptionTypeAdditional information
ExternalID

User's External ID

string

None.

Created

Date user was added to the system

date

None.

Country

User's country

string

None.

Name

User's name

string

None.

Age

User's age

string

None.

Location

User's location

string

None.

DateOfBirth

User's date of birth

string

None.

Gender

User's gender

string

None.

ID

The ID for the user

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ExternalID": "sample string 1",
    "Created": "2021-10-18T17:42:09.4428417+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": "195e0868-9cda-4331-8b14-73a9647b27a7"
  },
  {
    "ExternalID": "sample string 1",
    "Created": "2021-10-18T17:42:09.4428417+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": "195e0868-9cda-4331-8b14-73a9647b27a7"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models">
  <AccountResponse>
    <Age>sample string 4</Age>
    <Country>sample string 2</Country>
    <Created>2021-10-18T17:42:09.4428417+00:00</Created>
    <DateOfBirth>sample string 6</DateOfBirth>
    <ExternalID>sample string 1</ExternalID>
    <Gender>sample string 7</Gender>
    <ID>195e0868-9cda-4331-8b14-73a9647b27a7</ID>
    <Location>sample string 5</Location>
    <Name>sample string 3</Name>
  </AccountResponse>
  <AccountResponse>
    <Age>sample string 4</Age>
    <Country>sample string 2</Country>
    <Created>2021-10-18T17:42:09.4428417+00:00</Created>
    <DateOfBirth>sample string 6</DateOfBirth>
    <ExternalID>sample string 1</ExternalID>
    <Gender>sample string 7</Gender>
    <ID>195e0868-9cda-4331-8b14-73a9647b27a7</ID>
    <Location>sample string 5</Location>
    <Name>sample string 3</Name>
  </AccountResponse>
</ArrayOfAccountResponse>