Data Manager API
POST Get Table Data
This request returns all records in the specified table.
Resource URL
Resource Information
Response Formats | JSON, XML, CSV |
Authentication | Yes (Requires Key) |
Rate Limited | Yes |
Request Parameters
Request Parameter | Description | Required |
---|---|---|
key String | A unique key to authorize use of the API. | Yes |
inFormat String | Specifies the format of the json/xml parameter. Must be one of the following, if supplied:
json | No |
outFormat String | Specifies the format of the response. Must be one of the following, if supplied:
json | No |
Body Parameters
Name | Description | Required |
---|---|---|
clientId String | This is the ClientID associated with the API Key. | Yes |
password String | This is the registry password associated with the API Key. | Yes |
tableName String | This is the complete name of the table. Table names for legacy users are prefixed with mqap.CLIENT_ID_ Table names for new users are prefixed with mqap.APPLICATION_KEY_ | Yes |
orderBy String | The name of the column to order results by. | No |
extraCriteria String | A SQL query (Postgres syntax) to return specific results from the table that meet the criteria. | No |
parameters String | Query parameters; used with extraCriteria. | No |
maxMatches String | The maximum number of results to return. | No |
Example Request
POST https://www.mapquestapi.com/datamanager/v2/get-table-data?key=KEY&inFormat=json
Example Request Body
JSON
{
"clientId": "CLIENT_ID",
"password": "REGISTRY_PASSWORD",
"tableName": "TABLENAME"
}
XML
<datamanager>
<clientId>CLIENT_ID</clientId>
<password>REGISTRY_PASSWORD</password>
<tableName>TABLENAME</tableName>
</datamanager>
Example Response
JSON
{
"tableName": "mqap.TABLENAME",
"resultsCount": "...",
"data": {
"columns": [],
"rows": []
},
"tableSize": {
"raw": "...",
"readable": "...MB"
}
}
XML
<datamanager>
<tableName>mqap.TABLENAME</tableName>
<resultsCount>...</resultsCount>
<data>
<columns>
<column>...</column>
</columns>
<rows>
<row>...</row>
<rows>
</data>
<tableSize>
<raw>...</raw>
<readable>...</readable>
</tableSize>
</datamanager>