Planfix API contact.managePlanfixAccess

This function allows you to grant or deny access for a contact. Execution of this function requires admin rights. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.managePlanfixAccess">
  <account></account>
  <sid></sid>
  <contact>
    <id></id>
    <userid></userid>
    <general></general>
    <email></email>
    <havePlanfixAccess></havePlanfixAccess>
  </contact>
  <signature></signature>
</request>

Name	Type	Value	Note
id	int	contact identifier
userid	int	contact identifier for cases when it is used in the system on par with employees (task assignee, etc., as well as a custom field of the contact type)
general	int	contact number
email	string	use the specified e-mail to organize access to Planfix	optional parameter, used only the first time when opening access to Planfix
havePlanfixAccess	bool	deny (0) or grant(1) access to Planfix
signature	string(32)	signature

Result of successful function execution:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <id></id>
    <status></status>
  </contact>
</response>

Name	Type	Value	Note
id	int	contact identifier
status	enum	result of operation execution	see the list of acceptable values in the section result of contact.managePlanfixAccess execution

Otherwise, a response with an error will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Go To

• Planfix API:Contacts
• Error codes
• List of functions