Tools and News for Developers using the AllClients Platform

GetPermissions

Overview

Get Permissions for a Team Member based on information sent via an http form post.

Post Url

https://www.allclients.com/api/2/GetPermissions.aspx
  • SSL is requred
  • White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.

Form Fields

Field Max Length* Required Notes
response_type No Default results will be returned in XML. Set this field value to json to return results in JSON format
apiusername Yes API User Name and password are assigned by AllClients
apipassword Yes API User Name and password are assigned by AllClients
accountid Yes Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel
teammemberid Yes Must be numeric. Leave blank or use 0 (zero) for team leader

Sample Results

Success Message (XML)

<?xml version="1.0" encoding="UTF-8"?>
<results>
  <permissions>
    <ContactAdd>Deny</ContactAdd>
    <ContactEdit>Grant</ContactEdit>
    <ContactDelete>Grant</ContactDelete>
    <ToDoAdd>Grant</ToDoAdd>
    <ToDoEdit>Grant</ToDoEdit>
    <ToDoDelete>Grant</ToDoDelete>
    <VoiceTouchAccess>Grant</VoiceTouchAccess>
    <DealsAccess>Grant</DealsAccess>
    <ImportContacts>Grant</ImportContacts>
    <ExportContacts>Grant</ExportContacts>
    <TeamAdministration>Grant</TeamAdministration>
    <LogInAsOwner>Grant</LogInAsOwner>
    <ShareEmailLetterTemplates>Grant</ShareEmailLetterTemplates>
    <ClientTouchEmailBlast>Deny</ClientTouchEmailBlast>
    <ClientTouchGroupEditDelete>Grant</ClientTouchGroupEditDelete>
  </permissions>
</results>

Success Message (JSON)

{
 "results": {
 "permissions": {
   "ContactAdd": "Deny",
   "ContactEdit": "Grant",
   "ContactDelete": "Grant",
   "ToDoAdd": "Grant",
   "ToDoEdit": "Grant",
   "ToDoDelete": "Grant",
   "VoiceTouchAccess": "Grant",
   "DealsAccess": "Grant",
   "ImportContacts": "Grant",
   "ExportContacts": "Grant",
   "TeamAdministration": "Grant",
   "LogInAsOwner": "Grant",
   "ShareEmailLetterTemplates": "Grant",
   "ClientTouchEmailBlast": "Deny",
   "ClientTouchGroupEditDelete": "Grant"
   }
  }
 }

Sample Failure Message

<?xml version="1.0"?>
<results>
    <error>Authentication failed</error>
</results>