Data Manager API

POST
Get Custom Permissions

This request returns a list of all custom permissions that have been set for a specific table and non-owner ClientID.

Resource URL

http://www.mapquestapi.com/datamanager/v2/get-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. No
customerId
String
The non-owner ClientID that has been granted permissions to access the table and specified fields. No

Example Request

POST

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

Example Request Body

{
    "clientId": "CLIENT_ID",
    "password": "REGISTRY_PASSWORD",
    "tableName": "mqap.TABLENAME",
    "customerId": "CUSTOMER_ID"
}
<datamanager>
    <clientId>CLIENT_ID</clientId>
    <password>REGISTRY_PASSWORD</password>
    <tableName>TABLENAME</tableName>
    <customerId>CUSTOMER_ID</customerId>
</datamanager>

Example Response

{
    "customPermissions": [
        {
            "customerId": "...",
            "tableName": "...",
            "columns": [
                {
                    "name": "...",
                    "type": "...",
                    "isPublic": "..."
                }
            ]
        }
    ]
}
<customPermissions>
    <customPermission>
        <customerId>...</customerId>
        <tableName>...</tableName>
        <columns>
            <column>
                <name>...</name>
                <type>...</type>
                <isPublic>...</isPublic>
            </column>
        </columns>
    </customPermission>
</customPermissions>