POST api/Accounts/Fetch

Get a count of the number of accounts for the Organisation

Request Information

URI Parameters

None.

Body Parameters

Account data request

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

Name	Description	Type	Additional information
ID	The ID for the user	globally unique identifier	None.
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.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": "0337fba9-2d00-403c-bb40-ce0474a3b088",
    "ExternalID": "sample string 2",
    "Created": "2024-03-31T18:43:19.6587608+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": "0337fba9-2d00-403c-bb40-ce0474a3b088",
    "ExternalID": "sample string 2",
    "Created": "2024-03-31T18:43:19.6587608+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:

<ArrayOfAccountDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models.Accounts">
  <AccountDataResponse>
    <Age>sample string 5</Age>
    <Country>sample string 3</Country>
    <Created>2024-03-31T18:43:19.6587608+00:00</Created>
    <DateOfBirth>sample string 7</DateOfBirth>
    <ExternalID>sample string 2</ExternalID>
    <Gender>sample string 8</Gender>
    <ID>0337fba9-2d00-403c-bb40-ce0474a3b088</ID>
    <Location>sample string 6</Location>
    <Name>sample string 4</Name>
  </AccountDataResponse>
  <AccountDataResponse>
    <Age>sample string 5</Age>
    <Country>sample string 3</Country>
    <Created>2024-03-31T18:43:19.6587608+00:00</Created>
    <DateOfBirth>sample string 7</DateOfBirth>
    <ExternalID>sample string 2</ExternalID>
    <Gender>sample string 8</Gender>
    <ID>0337fba9-2d00-403c-bb40-ce0474a3b088</ID>
    <Location>sample string 6</Location>
    <Name>sample string 4</Name>
  </AccountDataResponse>
</ArrayOfAccountDataResponse>