queryType: getDatabaseInfo

The getDatabaseInfo queryType is passed to the API to get a list of counties to which the logged in database has access, as well as their licensing information.

Parameters

These parameters should be passed to the functionParameters object regardless of which method you choose to make an API request.


Parameter	Description	Type	Defined Value Set	Value Required
queryType	Must equal `getDatabaseInfo`.	STRING	`getDatabaseInfo`	Y

Responses


Code	Type	Description
200	JSON	The requested data.
401	JSON	Occurs for various unauthorized tasks, such as not providing credentials in your parameters.
500	JSON	Occurs if an internal server error occurs. Contact Altitude Support if this occurs.

Response Schema


Attribute	Description	Data Type	Defined Value Set
Applications	Array of strings holding the names of all purchased applications.	ARRAY	"Traffic - Roads", "Origin/ Destination", "Route Analytics", "User Management", "Altitude Portal", "Custom Zones", "Stop Analytics", "Regional Travel Metrics", "Point of Interest"
Comments	Comments about the database.	STRING	-
Counties	Array of objects representing counties purchased. Each object contains: `ISO_3166_2` (string) - unique ISO 3166:2 identifier representing the state/provincial code of the purchased region. `CountyId` (string): a unique identifier for a county; typically, the FIPS code or Canadian census subdivision CSDUID from StatCan. `County` (string): name of the county.	ARRAY	-
CreatedTimestamp	Timestamp for when the database was created.	TIMESTAMP	-
Database	Name of the database.	STRING	-
DataDateRanges	Array of objects representing purchased data date ranges. Each object contains: `StartDate` (date): the start of the date range. `EndDate` (date): the end of the date range.	ARRAY	-
DomainsAllowed	Array of strings representing the email domains allowed for users of this database.	ARRAY	-
ExpiryDate	Date when the license expires and the user loses access to the database.	DATE	-
IsTrial	Indicates whether the database is a trial (true) or not (false).	BOOLEAN	True or False
LicenseId	Type of license.	INTEGER	1 - Project, 2 - Subscription, 3 - Reseller
MaxSavedAnalysesPerModule	The maximum number of saved past analyses per module/application	INTEGER	-
MaxUserCount	The maximum number of users that can be loaded on this database.	INTEGER	-
ModifiedTimestamp	Timestamp for when the database was last modified.	TIMESTAMP	-

Sample parameters

{"queryType": "getDatabaseInfo"}

POI Location Specific Insights

When using POI Location Specific Insights, access database configuration via the REST proxy at GET /api/v2/databases/config. Use the poiNaicsAllowed field to determine which categories are licensed before calling any POI endpoint. The table below lists the POI-relevant fields returned by this endpoint. The endpoint returns additional platform configuration fields beyond those listed here.


Field	Type	Description
`poiNaicsAllowed`	ARRAY	North American Industry Classification System (NAICS) Level 2 category codes the database is licensed to access in POI analytics. Pass these codes as the `naicsLevel2` parameter in getPointsOfInterest, getPOISummary, and getPOIAnalytics calls.
`applicationIds`	ARRAY	Altitude application identifiers enabled for this database. POI Location Specific Insights appears in this array when the module is enabled.
`isTrial`	BOOLEAN	true if the database is on a trial subscription.
`isExpired`	BOOLEAN	true if the subscription has passed its expiry date.
`expiresOn`	STRING	ISO 8601 date on which the subscription expires.
`daysBeforeExpiration`	INTEGER	Calendar days until expiry. Returns a negative value when the subscription has already expired.
`availableDates`	ARRAY	Date ranges for which Geotab data is available for this database.