/app/get_provider_permissions
This call returns an Engage application’s permissions for a provider, as set with the set_provider_permissions call. Refer to set_provider_permissions for permissions details.
URL
https://rpxnow.com/partner/v2/app/get_provider_permissions
Request
| Parameter | Required | Description |
|---|---|---|
apiKeystring | Yes | The Engage apiKey for the application you are investigating. |
partnerKeystring | Yes | Your Engage partner key, which is on the dashboard. |
providerstring | Yes | The name of the provider about which you want information. |
formatstring | No | The response format: either xml or json. If not specified, the response defaults to json. |
Response
| Parameter | Type | Description |
|---|---|---|
stat | dictionary | This response is either ok or fail. If it fails, it includes information on what went wrong. Otherwise, the remainder of these fields will be present. |
permissions | dictionary | A list of all the permissions that have been configured for the specified provider with the set_provider_permissions call. See the documentation on set_provider_permissions for a list of all available permissions for each provider. |
Example Response
{
"stat": "ok",
"permissions": ["readContactsCheckins","manageNotifications","publishCheckins","readCheckins","sendSms","chatLogin","managePages","manageAds","readRequests","readMailbox","rsvpEvent","offlineAccess","onlinePresence","readContactLists","contactsOnlinePresence","createEvent"]
}
<?xml version="1.0" encoding="UTF-8" ?> <stat>ok</stat> <permissions>readContactsCheckins</permissions> <permissions>manageNotifications</permissions> <permissions>publishCheckins</permissions> <permissions>readCheckins</permissions> <permissions>sendSms</permissions> <permissions>chatLogin</permissions> <permissions>managePages</permissions> <permissions>manageAds</permissions> <permissions>readRequests</permissions> <permissions>readMailbox</permissions> <permissions>rsvpEvent</permissions> <permissions>offlineAccess</permissions> <permissions>onlinePresence</permissions> <permissions>readContactLists</permissions> <permissions>contactsOnlinePresence</permissions> <permissions>createEvent</permissions>