Data Manager API
POST Get Tables
This request returns a list of tables that belong to the API Key and ClientID that is making the request. If the includePublic
parameter is set to true
, all tables that have been marked as publicly available will be returned as well.
Resource URL
Resource Information
Response Formats | JSON, XML |
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 |
includePublic Boolean | This parameter will return names and column information for tables that have been made public. The default value is false . | No |
Example Request
POST https://www.mapquestapi.com/datamanager/v2/get-tables?key=KEY&inFormat=json&outFormat=json
Example Request Body
JSON
{
"clientId": "CLIENT_ID",
"password": "REGISTRY_PASSWORD",
"includePublic": true
}
XML
<datamanager>
<clientId>CLIENT_ID</clientId>
<password>REGISTRY_PASSWORD</password>
<includePublic>true</includePublic>
</datamanager>
Example Response
JSON
"tables":[
{
"tableName": "...",
"friendlyName": "...",
"notes": "...",
"owner": "...",
"isPublic": "...",
"totalRows": "...",
"columns":[
{
"name": "...",
"type": "...",
"isPublic": "..."
}
]
}
]
XML
<tables>
<table>
<tableName>...</tableName>
<friendlyName>...</friendlyName>
<notes>...</notes>
<owner>...</owner>
<isPublic>...</isPublic>
<totalRows>...</totalRows>
<columns>
<column>
<name>...</name>
<type>...</type>
<isPublic>...</isPublic>
</column>
</columns>
</table>
</tables>