Table of Contents

Api contacts

contact.create

Create a new contact and return the corresponding contact_id.

Request:

<?xml version=“1.0” encoding=“UTF-8”?>

<request method=“contact.create”>

<contact>
	<client_id>1</client_id>										//mandatory
	<first_name>Jane</first_name>								//mandatory
	<last_name>Doe</last_name>									//mandatory
	<email>janedoe@janedoe.com</email>					//mandatory
	<phone>(123) 456-7890</phone>
	<mobile_phone>(123) 456-7890</mobile_phone>
</contact>	

</request>

Response:

<?xml version=“1.0” encoding=“UTF-8”?>

<response status=“ok”>

<contact_id>1</contact_id>

</response>

contact.update

Update the details of the contact with the given contact_id.

Any fields not referenced in the request will remain unchanged.

Request:

<?xml version=“1.0” encoding=“UTF-8”?>

<request method=“contact.update”>

<contact>
  <contact_id>1</contact_id>
  
  # Same params as contact.create
</contact>

</request>

Response:

<?xml version=“1.0” encoding=“UTF-8”?>

<response status=“ok”/>

contact.get

Return the contact details associated with the given contact_id.

Request

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.get">
  <contact_id>1</contact_id>
</request>

Response

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
	<contact>
		<contact_id>1</contact_id>
		<first_name>Jane</first_name>
		<last_name>Doe</last_name>
		<email>janedoe@janedoe.com</email>
		<phone>(123) 456-7890</phone>
		<mobile_phone>(123) 456-7890</mobile_phone>
	</contact>	
</response>

Deleting Contacts contact.delete

Delete the contact with the given contact_id.

Request

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.delete">
  <contact_id>1</contact_id>
</request>
<code>
 
Response
<code xml>
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok"/>
<code>
 
 
Listing Contacts
contact.list
 
Returns a list of contacts.
 
Request
<code xml>
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.list">
  <client_id>1</client_id> 		# Filter by client (Optional)
  <email>janedoe@janedoe.com</email> 	# Filter by email (Optional)
  <page>1</page>                        # The page number to show (Optional)
  <per_page>15</per_page>               # Number of results per page, default 25 (Optional)
</request>
<code>
 
Response
<code xml>
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
		<contact>
			<contact_id>1</contact_id>
			<first_name>Jane</first_name>
			<last_name>Doe</last_name>
			<email>janedoe@janedoe.com</email>
			<phone>(123) 456-7890</phone>
			<mobile_phone>(123) 456-7890</mobile_phone>
		</contact>	
</response>
 
acuinvoice_api/contacts.txt · Last modified: 2008/05/23 05:12 by admin
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki