| Name | Description | Type | Additional information |
|---|---|---|---|
| APIVersion |
Current version number of the API. |
string |
None. |
| SQLServerName |
Instance of SQL Server that is hosting the database. |
string |
None. |
| SQLDatabaseName |
Name of the SQL Server database. |
string |
None. |
| Scopes |
List of Scopes for the authorized user. |
Collection of string |
None. |
| _links |
Links to other API resources that are related to the information in this model. This is part of the HAL specification. This property is not required on PUT or POST requests to this endpoint. |
None. |
|
| _embedded |
Resources/models representing data that is related to the data in this model. This is part of the HAL specification. These models have their own HAL links and embedded resources. This property is not required on PUT or POST requests to this endpoint. |
None. |
Embedded Resources
The HAL standard calls for complex properties (properties who have their own HAL markup) be represented in a base model's "_embedded" tag rather than as properties or collections on the underlying model. The model described above can also include the following types of related models in it's _embedded property.
| Model | Description |
|---|---|
| UserDetailed | The UserDetailed model represents detailed information about a user of an Advisors Assistant database application (desktop app or web app). |