Data Manager API

POST
Edit Custom Permissions

This request edits custom table and column-level permissions that have been set for non-owner ClientIDs. When setting individual columns to public, the isPublic parameter for the table level must also be set to true, or no columns will be visible regardless of their isPublic setting.

Resource URL

http://www.mapquestapi.com/datamanager/v2/edit-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
customerId
String
The non-owner ClientID that has been granted permissions to access the table and specified fields. Yes
columnPermissions
String[]
An array of columns with updated permissions. Yes

Example Request

POST

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

Example Request Body

{
    "clientId": "CLIENT_ID",
    "password": "CLIENT_PASSWORD",
    "tableName": "mqap.TABLENAME",
    "customerId": "CUSTOMER_ID",
    "columnPermissions": [
        {
            "name": "NAME",
            "isPublic": "IS_PUBLIC"
        },
        {
            "name": "NAME",
            "isPublic": "IS_PUBLIC"
        }
    ],
    "isPublic": "IS_PUBLIC"
}
<datamanager>
    <clientId>CLIENT_ID</clientId>
    <password>REGISTRY_PASSWORD</password>
    <tableName>TABLENAME</tableName>
    <customerId>CUSTOMER_ID</customerId>
    <columnPermissions>
        <columnPermission>
            <name>NAME</name>
            <isPublic>IS_PUBLIC</isPublic>
        </columnPermission>
        ...
    </columnPermissions>
    <isPublic>IS_PUBLIC</isPublic>
</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>