Names
This endpoint uses model(s) representing Names (individual people or organizations/businesses). Many other models relate to the Names, including Addresses, Email Addresses, Phone Numbers, Note Topics, etc. There are 2 different Name models; a 'simple' model with basic name information suitable for building lookups and a 'detailed' model with more extensive information about the names. GET requests sent to the '/Names' endpoint directly will return the same results as if the '/Names/Detailed' endpoint had been specified. GET requests must explicitly be made to the '/Names/Simple' endpoint in order to get simple name models back. The two endpoints also differ in how the search parameters are processed when NO limiting criteria are passed in via the parameters. GET requests to the '/Names' or the '/Names/Detailed' endpoints that (have NO limiting criteria) will return no names (a 404 result), whereas GET requests to the '/Names/Simple' endpoint (that have NO limiting criteria) will return ALL names.
| API | Description |
|---|---|
| POST {apiVersion}/Names/NewLead |
Allow the submittion of a new lead. This action will create a new name record and also add records to all the associated tables |
Ping
This endpoint is for checking to see if the API is running and the authorization is valid.
| API | Description |
|---|---|
| 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. |
Users
This endpoint uses model(s) representing Dashboard Users of the Advisors Assistant applications.
| API | Description |
|---|---|
| GET {apiVersion}/Users/Me |
This endpoints is being used by the NewLead function to retrieve the user name |