POST api/Accounts/Create
Create a new account on the system
Request Information
URI Parameters
None.
Body Parameters
Account data
AccountModelName | Description | Type | Additional 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. |
OrganisationName | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ID": "5e8d078f-dee9-4122-95cd-d7589b881666", "ExternalID": "sample string 2", "Name": "sample string 3", "DOB": "2024-04-24T09:16:45.3614385+00:00", "Gender": "sample string 4", "Devices": "sample string 5", "Country": "sample string 6", "Age": 1, "Location": "sample string 8", "Created": "2024-04-24T09:16:45.3614385+00:00", "HasDevices": true, "OrganisationName": "sample string 9" }
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>2024-04-24T09:16:45.3614385+00:00</Created> <DOB>2024-04-24T09:16:45.3614385+00:00</DOB> <Devices>sample string 5</Devices> <ExternalID>sample string 2</ExternalID> <Gender>sample string 4</Gender> <HasDevices>true</HasDevices> <ID>5e8d078f-dee9-4122-95cd-d7589b881666</ID> <Location>sample string 8</Location> <Name>sample string 3</Name> <OrganisationID>e25df999-b745-4834-96f5-03bfb93d5e8a</OrganisationID> <OrganisationName>sample string 9</OrganisationName> </AccountModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AccountModelName | Description | Type | Additional 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. |
OrganisationName | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ID": "5074a973-6473-4352-b7f9-4c58ae71c090", "ExternalID": "sample string 2", "Name": "sample string 3", "DOB": "2024-04-24T09:16:45.6895647+00:00", "Gender": "sample string 4", "Devices": "sample string 5", "Country": "sample string 6", "Age": 1, "Location": "sample string 8", "Created": "2024-04-24T09:16:45.6895647+00:00", "HasDevices": true, "OrganisationName": "sample string 9" }
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>2024-04-24T09:16:45.6895647+00:00</Created> <DOB>2024-04-24T09:16:45.6895647+00:00</DOB> <Devices>sample string 5</Devices> <ExternalID>sample string 2</ExternalID> <Gender>sample string 4</Gender> <HasDevices>true</HasDevices> <ID>5074a973-6473-4352-b7f9-4c58ae71c090</ID> <Location>sample string 8</Location> <Name>sample string 3</Name> <OrganisationID>b0624153-4fcb-46cf-b757-8c5ef21cdb35</OrganisationID> <OrganisationName>sample string 9</OrganisationName> </AccountModel>