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 Req'd |
|---|---|---|---|---|
| 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" |
| Comments | Comments about the database. | STRING | - |
| Counties |
Array of objects representing counties purchased. Each object contains:
| 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:
| 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 | - |
| 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"}