GET {apiVersion}/Ping

Get the current version number of the API and verify which specific Advisors Assistant database is being connected to on behalf of the authorized user. Also get information about the authorized user including IDs that can be used to access the user's calendar, etc.

Request Information

URI Parameters

Name	Description	Type	Additional information
apiVersion	Required routing parameter defining which version of the API to call. Currently use "v1" for all API requests.	string	None.

Body Parameters

None.

Response Information

Resource Description

Ping

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).

Response Formats

application/hal+json

Sample:

{
  "APIVersion": "sample string 1",
  "SQLServerName": "sample string 2",
  "SQLDatabaseName": "sample string 3",
  "Scopes": [
    "sample string 1",
    "sample string 2"
  ],
  "_links": {
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3",
      "type": "sample string 4",
      "deprecation": "sample string 5",
      "name": "sample string 6",
      "profile": "sample string 7",
      "hreflang": "sample string 8"
    },
    "self": {
      "href": "/v1/Ping",
      "title": "Ping"
    },
    "user": {
      "href": "/v1/Users/Detailed/1305b9b3-84d2-44cf-b629-e71fc69de1be",
      "title": "sample string 4"
    }
  },
  "_embedded": {
    "user": {
      "WhenChangedDateTime": "2024-04-29T18:51:43-07:00",
      "WhoChanged": "sample string 1",
      "WhenAddedDateTime": "2024-04-29T18:51:43-07:00",
      "WhoAdded": "sample string 2",
      "DefaultProducerID": "50b6b066-1121-410d-9547-d7b81b1a72f3",
      "NameID": "c3d33235-bc44-400c-8aed-6c0bccf72d7d",
      "DefaultCalendarID": "3254838c-1250-451d-87a4-7b6611d24fd8",
      "CalendarsExplicitlyAccessible": [
        {
          "ID": "3690d01e-5ee5-4f71-9057-e7dcfa0eb287",
          "Description": "sample string 1"
        },
        {
          "ID": "3690d01e-5ee5-4f71-9057-e7dcfa0eb287",
          "Description": "sample string 1"
        }
      ],
      "HasViewAllCalendarsPermission": true,
      "HasSystemAdministratorRole": true,
      "ID": "1305b9b3-84d2-44cf-b629-e71fc69de1be",
      "Initials": "sample string 3",
      "DisplayName": "sample string 4",
      "EmailAddress": "sample string 5",
      "_links": {
        "sample string 1": {
          "href": "sample string 2",
          "title": "sample string 3",
          "type": "sample string 4",
          "deprecation": "sample string 5",
          "name": "sample string 6",
          "profile": "sample string 7",
          "hreflang": "sample string 8"
        },
        "self": {
          "href": "/v1/Users/Detailed/1305b9b3-84d2-44cf-b629-e71fc69de1be",
          "title": "sample string 4"
        }
      },
      "_embedded": null
    }
  }
}