Data Manager API

POST
Grant Custom Permissions

This request grants custom column permissions to non-owner ClientIDs. Once custom permissions are specified, the table will be available for those non-owner ClientIDs when making a get-table-data call and setting the includePublic parameter to true.

Resource URL

http://www.mapquestapi.com/datamanager/v2/grant-custom-permissions

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
  • xml
Default = json
No
outFormat
String
Specifies the format of the response. Must be one of the following, if supplied:
  • json
  • xml
Default = 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
The name of the table. Yes
customerId
String
The non-owner ClientID that has been granted permissions to access the table and specified fields. Yes
columnNames
String[]
An array of columns to grant access to.
NAME - the name(s) of the field(s) that the non-owner ClientID will be able to access.
Yes

Example Request

POST

http://www.mapquestapi.com/datamanager/v2/grant-custom-permissions?key=KEY&inFormat=json&outFormat=json

Example Request Body

{
    "clientId": "CLIENT_ID",
    "password": "REGISTRY_PASSWORD",
    "tableName": "mqap.TABLENAME",
    "customerId": "CUSTOMER_ID",
    "columnNames": [
      {
        "name": "Field_name1"
      },
      {
        "name": "Field_name2"
      }
    ]
}
<datamanager>
    <clientId>CLIENT_ID</clientId>
    <password>REGISTRY_PASSWORD</password>
    <tableName>TABLENAME</tableName>
    <customerId>CUSTOMER_ID</customerId>
    <columnNames>
        <name>NAME</name>
    </columnNames>
</datamanager>

Example Response

{
    "tableName": "mqap.TABLENAME",
    "customerId": "...",
    "columns": [
        {
            "name": "...",
            "isPublic": "..."
        },
        "..."
    ]
}
<datamanager>
    <tableName>mqap.TABLENAME</tableName>
    <customerId>...</customerId>
    <columns>
        <column>
            <name>...</name>
            <isPublic>...</isPublic>
        </column>
    </columns>
</datamanager>