API Documentation - User contributions [en]

Sample Applications

WikiSysop — Fri, 05 Oct 2012 14:07:23 GMT

WikiSysop: /* form.html */

Below are sample applications built using the API, coded in PHP. These samples demonstrate a variety of common use cases. While we do not cover every possible use of the API here, these samples are meant to be indicative of all API calls.

All samples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any method that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Sample 1: mailing list signup form ==
This application allows a site visitor to add himself or herself to a an agent's contact list, while also adding the new contact to a predefined distribution list. The application consists of two files: an HTML file containing a simple signup form, and a PHP file which processes form submissions and makes the necessary API calls.

The files are included below, or you can [http://api.rezora.com/documentation/samples/rezora_api_add_contact_form.zip download them here].

=== form.html ===
The form contains two fields: name, and email address. However, this could be expanded to include any of the fields supported by the contacts collection resource.
<source lang="html4strict">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<h1>Add a Contact</h1>
<form action="form_processor.php" method="post" name="addcontactform" id="addcontactform">
<div>
<label for="name">Name:</label>
<input type="text" name="name" id="name" value="" />
</div>
<div>
<label for="email">Email address:</label>
<input type="text" name="email" id="email" value="" />
</div>
<div>
<input type="submit" value="Submit" />
</div>
</form>
</body>
</html>
</source>

=== form_processor.php ===
This script should be considered a starting point, and requires some customization, notably in the areas of user input validation and user response messages.
<source lang="php">
<?php
/*
* This script uses the Rezora Agent API to add a new contact entry to an agent's account,
* and to add that contact to a specified Distribution List so that newly added contacts
* may be easily identified by the agent from within the Rezora system.
* See http://api.rezora.com/ for the full API documentation.
*/

// Set some configuration constants.
// Your Agent API Key username and password are available on your Rezora My Account page.
define('API_USERNAME', 'YOUR_API_USERNAME');
define('API_PASSWORD', 'YOUR_API_PASSWORD');
define('API_BASEURI', 'http://api.rezora.com/v1/');
define('API_FORMAT', 'application/json');

// Set the ID of the distribution list to which new contacts will be added.
// You should create a distribution list (called something like "Website Signup") exclusively for this purpose.
// You can get the ID of a lsit by using the Lists API Resource, or by noting the ID in the HTML code on the agent's Contacts page within the Rezora system.
// Leave the value as zero to skip this step (not recommended).
$intListID = 0;

// Validate the user-submitted form data before proceding
if (validateUserData()) {
// First, we'll be posting data to the contacts collection resource to create a new contact.
// Set some configuration variables specific to the task at hand.
$strResource = 'contacts';
$strData = '{
"data":{
"contact_name":"' . $_POST['name'] . '",
"contact_email":"' . $_POST['email'] . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);

// Make sure we successfully added the contact before continuing
if ($intListID > 0 && $arrResponse['status'] == 200) {
// Next, we'll be posting data to the lists/ID/contacts collection resource to associate the new contact with the specified distribution list.
// Set some configuration variables specific to the task at hand.
$strResource = 'lists/' . $intListID . '/contacts';
$strData = '{
"data":{
"contact_id":"' . $arrResponse['body'][0]->contact_id . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);
}

// Get a status message to diplay to the user.
$strMessage = getStatusMessage($arrResponse['status']);
} else {
// Send a message to the user explaining wehat they have done wrong.
// Your validateUserData() function should probably provide detailed error messages.
$strMessage = 'You must provide valid information. Please try again.';
}

// Function for validating the user-submitted form data
function validateUserData() {
// You'll probably want to put some code here to validate whatever input you're receiving from the user.
return true;
}

// Make an API POST request
function doAPIPost($strResourcePath, $strData) {
// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, API_USERNAME . ':' . API_PASSWORD);
curl_setopt($ch, CURLOPT_URL, API_BASEURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . API_FORMAT, 'Content-type: ' . API_FORMAT));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and capture the response and status code.
$arrResponse['body'] = json_decode(curl_exec($ch));
$arrResponse['status'] = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// Close the cURL resource
curl_close($ch);

return $arrResponse;
}

// Return a status message to display to the user.
function getStatusMessage($strStatus) {
// An array of all status codes.
// These descriptions are rather technical. You may want to make them more user-friendly for production.
$arrStatuses = array(
'200' => 'The request was successfully processed.',
'204' => 'The request was formatted correctly, but no data was found for the specified resource.',
'400' => 'Your data has failed a validation test.',
'401' => 'Either your username or password are incorrect, or you are attempting to access a resource that is not available for your user type.',
'404' => 'The resource you have requested does not exist.',
'405' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) is not allowed for the resource you have requested.',
'500' => 'The API experienced an internal error while attempting to process your request.',
'501' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) has not yet been implemented, but may be in a future release.'
);
// Look up the message that corresponds to the status code
if (array_key_exists($strStatus, $arrStatuses)) {
$strMessage = $arrStatuses[$strStatus];
} else {
// Use a default message if no match was found
$strMessage = 'An unknown error occurred while attempting to add your information. Please try again.';
}
return $strMessage;
}
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<?php echo $strMessage ?>
</body>
</html>
</source>

Sample Applications

WikiSysop — Fri, 05 Oct 2012 13:08:46 GMT

WikiSysop: /* Sample 1: mailing list signup form */

Below are sample applications built using the API, coded in PHP. These samples demonstrate a variety of common use cases. While we do not cover every possible use of the API here, these samples are meant to be indicative of all API calls.

All samples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any method that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Sample 1: mailing list signup form ==
This application allows a site visitor to add himself or herself to a an agent's contact list, while also adding the new contact to a predefined distribution list. The application consists of two files: an HTML file containing a simple signup form, and a PHP file which processes form submissions and makes the necessary API calls.

The files are included below, or you can [http://api.rezora.com/documentation/samples/rezora_api_add_contact_form.zip download them here].

=== form.html ===
The form contains two fields: name, and email address. Hows=ever, this could be expanded to include any of the fields supported by the contacts collection resource.
<source lang="html4strict">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<h1>Add a Contact</h1>
<form action="form_processor.php" method="post" name="addcontactform" id="addcontactform">
<div>
<label for="name">Name:</label>
<input type="text" name="name" id="name" value="" />
</div>
<div>
<label for="email">Email address:</label>
<input type="text" name="email" id="email" value="" />
</div>
<div>
<input type="submit" value="Submit" />
</div>
</form>
</body>
</html>
</source>

=== form_processor.php ===
This script should be considered a starting point, and requires some customization, notably in the areas of user input validation and user response messages.
<source lang="php">
<?php
/*
* This script uses the Rezora Agent API to add a new contact entry to an agent's account,
* and to add that contact to a specified Distribution List so that newly added contacts
* may be easily identified by the agent from within the Rezora system.
* See http://api.rezora.com/ for the full API documentation.
*/

// Set some configuration constants.
// Your Agent API Key username and password are available on your Rezora My Account page.
define('API_USERNAME', 'YOUR_API_USERNAME');
define('API_PASSWORD', 'YOUR_API_PASSWORD');
define('API_BASEURI', 'http://api.rezora.com/v1/');
define('API_FORMAT', 'application/json');

// Set the ID of the distribution list to which new contacts will be added.
// You should create a distribution list (called something like "Website Signup") exclusively for this purpose.
// You can get the ID of a lsit by using the Lists API Resource, or by noting the ID in the HTML code on the agent's Contacts page within the Rezora system.
// Leave the value as zero to skip this step (not recommended).
$intListID = 0;

// Validate the user-submitted form data before proceding
if (validateUserData()) {
// First, we'll be posting data to the contacts collection resource to create a new contact.
// Set some configuration variables specific to the task at hand.
$strResource = 'contacts';
$strData = '{
"data":{
"contact_name":"' . $_POST['name'] . '",
"contact_email":"' . $_POST['email'] . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);

// Make sure we successfully added the contact before continuing
if ($intListID > 0 && $arrResponse['status'] == 200) {
// Next, we'll be posting data to the lists/ID/contacts collection resource to associate the new contact with the specified distribution list.
// Set some configuration variables specific to the task at hand.
$strResource = 'lists/' . $intListID . '/contacts';
$strData = '{
"data":{
"contact_id":"' . $arrResponse['body'][0]->contact_id . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);
}

// Get a status message to diplay to the user.
$strMessage = getStatusMessage($arrResponse['status']);
} else {
// Send a message to the user explaining wehat they have done wrong.
// Your validateUserData() function should probably provide detailed error messages.
$strMessage = 'You must provide valid information. Please try again.';
}

// Function for validating the user-submitted form data
function validateUserData() {
// You'll probably want to put some code here to validate whatever input you're receiving from the user.
return true;
}

// Make an API POST request
function doAPIPost($strResourcePath, $strData) {
// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, API_USERNAME . ':' . API_PASSWORD);
curl_setopt($ch, CURLOPT_URL, API_BASEURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . API_FORMAT, 'Content-type: ' . API_FORMAT));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and capture the response and status code.
$arrResponse['body'] = json_decode(curl_exec($ch));
$arrResponse['status'] = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// Close the cURL resource
curl_close($ch);

return $arrResponse;
}

// Return a status message to display to the user.
function getStatusMessage($strStatus) {
// An array of all status codes.
// These descriptions are rather technical. You may want to make them more user-friendly for production.
$arrStatuses = array(
'200' => 'The request was successfully processed.',
'204' => 'The request was formatted correctly, but no data was found for the specified resource.',
'400' => 'Your data has failed a validation test.',
'401' => 'Either your username or password are incorrect, or you are attempting to access a resource that is not available for your user type.',
'404' => 'The resource you have requested does not exist.',
'405' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) is not allowed for the resource you have requested.',
'500' => 'The API experienced an internal error while attempting to process your request.',
'501' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) has not yet been implemented, but may be in a future release.'
);
// Look up the message that corresponds to the status code
if (array_key_exists($strStatus, $arrStatuses)) {
$strMessage = $arrStatuses[$strStatus];
} else {
// Use a default message if no match was found
$strMessage = 'An unknown error occurred while attempting to add your information. Please try again.';
}
return $strMessage;
}
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<?php echo $strMessage ?>
</body>
</html>
</source>

Sample Applications

WikiSysop — Fri, 05 Oct 2012 13:02:49 GMT

WikiSysop:

Below are sample applications built using the API, coded in PHP. These samples demonstrate a variety of common use cases. While we do not cover every possible use of the API here, these samples are meant to be indicative of all API calls.

All samples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any method that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Sample 1: mailing list signup form ==
This application allows a site visitor to add himself or herself to a an agent's contact list, while also adding the new contact to a predefined distribution list. The application consists of two files: an HTML file containing a simple signup form, and a PHP file which processes form submissions and makes the necessary API calls.

The files are included below, or you can download them here.

=== form.html ===
The form contains two fields: name, and email address. Hows=ever, this could be expanded to include any of the fields supported by the contacts collection resource.
<source lang="html4strict">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<h1>Add a Contact</h1>
<form action="form_processor.php" method="post" name="addcontactform" id="addcontactform">
<div>
<label for="name">Name:</label>
<input type="text" name="name" id="name" value="" />
</div>
<div>
<label for="email">Email address:</label>
<input type="text" name="email" id="email" value="" />
</div>
<div>
<input type="submit" value="Submit" />
</div>
</form>
</body>
</html>
</source>

=== form_processor.php ===
This script should be considered a starting point, and requires some customization, notably in the areas of user input validation and user response messages.
<source lang="php">
<?php
/*
* This script uses the Rezora Agent API to add a new contact entry to an agent's account,
* and to add that contact to a specified Distribution List so that newly added contacts
* may be easily identified by the agent from within the Rezora system.
* See http://api.rezora.com/ for the full API documentation.
*/

// Set some configuration constants.
// Your Agent API Key username and password are available on your Rezora My Account page.
define('API_USERNAME', 'YOUR_API_USERNAME');
define('API_PASSWORD', 'YOUR_API_PASSWORD');
define('API_BASEURI', 'http://api.rezora.com/v1/');
define('API_FORMAT', 'application/json');

// Set the ID of the distribution list to which new contacts will be added.
// You should create a distribution list (called something like "Website Signup") exclusively for this purpose.
// You can get the ID of a lsit by using the Lists API Resource, or by noting the ID in the HTML code on the agent's Contacts page within the Rezora system.
// Leave the value as zero to skip this step (not recommended).
$intListID = 0;

// Validate the user-submitted form data before proceding
if (validateUserData()) {
// First, we'll be posting data to the contacts collection resource to create a new contact.
// Set some configuration variables specific to the task at hand.
$strResource = 'contacts';
$strData = '{
"data":{
"contact_name":"' . $_POST['name'] . '",
"contact_email":"' . $_POST['email'] . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);

// Make sure we successfully added the contact before continuing
if ($intListID > 0 && $arrResponse['status'] == 200) {
// Next, we'll be posting data to the lists/ID/contacts collection resource to associate the new contact with the specified distribution list.
// Set some configuration variables specific to the task at hand.
$strResource = 'lists/' . $intListID . '/contacts';
$strData = '{
"data":{
"contact_id":"' . $arrResponse['body'][0]->contact_id . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);
}

// Get a status message to diplay to the user.
$strMessage = getStatusMessage($arrResponse['status']);
} else {
// Send a message to the user explaining wehat they have done wrong.
// Your validateUserData() function should probably provide detailed error messages.
$strMessage = 'You must provide valid information. Please try again.';
}

// Function for validating the user-submitted form data
function validateUserData() {
// You'll probably want to put some code here to validate whatever input you're receiving from the user.
return true;
}

// Make an API POST request
function doAPIPost($strResourcePath, $strData) {
// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, API_USERNAME . ':' . API_PASSWORD);
curl_setopt($ch, CURLOPT_URL, API_BASEURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . API_FORMAT, 'Content-type: ' . API_FORMAT));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and capture the response and status code.
$arrResponse['body'] = json_decode(curl_exec($ch));
$arrResponse['status'] = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// Close the cURL resource
curl_close($ch);

return $arrResponse;
}

// Return a status message to display to the user.
function getStatusMessage($strStatus) {
// An array of all status codes.
// These descriptions are rather technical. You may want to make them more user-friendly for production.
$arrStatuses = array(
'200' => 'The request was successfully processed.',
'204' => 'The request was formatted correctly, but no data was found for the specified resource.',
'400' => 'Your data has failed a validation test.',
'401' => 'Either your username or password are incorrect, or you are attempting to access a resource that is not available for your user type.',
'404' => 'The resource you have requested does not exist.',
'405' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) is not allowed for the resource you have requested.',
'500' => 'The API experienced an internal error while attempting to process your request.',
'501' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) has not yet been implemented, but may be in a future release.'
);
// Look up the message that corresponds to the status code
if (array_key_exists($strStatus, $arrStatuses)) {
$strMessage = $arrStatuses[$strStatus];
} else {
// Use a default message if no match was found
$strMessage = 'An unknown error occurred while attempting to add your information. Please try again.';
}
return $strMessage;
}
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<?php echo $strMessage ?>
</body>
</html>
</source>

Sample Applications

WikiSysop — Fri, 05 Oct 2012 13:01:26 GMT

WikiSysop:

Below are sample applications built using the API, coded in PHP. These samples demonstrate a variety of common use cases. While we do not cover every possible use of the API here, these samples are meant to be indicative of all API calls.

All samples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any method that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Sample 1: mailing list signup form ==
This application allows a site visitor to add himself or herself to a an agent's contact list, while also adding the new contact to a predefined distribution list. The application consists of two files: an HTML file containing a simple signup form, and a PHP file which processes form submissions and makes the necessary API calls.

=== form.html ===
The form contains two fields: name, and email address. Hows=ever, this could be expanded to include any of the fields supported by the contacts collection resource.
<source lang="html4strict">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<h1>Add a Contact</h1>
<form action="form_processor.php" method="post" name="addcontactform" id="addcontactform">
<div>
<label for="name">Name:</label>
<input type="text" name="name" id="name" value="" />
</div>
<div>
<label for="email">Email address:</label>
<input type="text" name="email" id="email" value="" />
</div>
<div>
<input type="submit" value="Submit" />
</div>
</form>
</body>
</html>
</source>

=== form_processor.php ===
This script should be considered a starting point, and requires some customization, notably in the areas of user input validation and user response messages.
<source lang="php">
<?php
/*
* This script uses the Rezora Agent API to add a new contact entry to an agent's account,
* and to add that contact to a specified Distribution List so that newly added contacts
* may be easily identified by the agent from within the Rezora system.
* See http://api.rezora.com/ for the full API documentation.
*/

// Set some configuration constants.
// Your Agent API Key username and password are available on your Rezora My Account page.
define('API_USERNAME', 'YOUR_API_USERNAME');
define('API_PASSWORD', 'YOUR_API_PASSWORD');
define('API_BASEURI', 'http://api.rezora.com/v1/');
define('API_FORMAT', 'application/json');

// Set the ID of the distribution list to which new contacts will be added.
// You should create a distribution list (called something like "Website Signup") exclusively for this purpose.
// You can get the ID of a lsit by using the Lists API Resource, or by noting the ID in the HTML code on the agent's Contacts page within the Rezora system.
// Leave the value as zero to skip this step (not recommended).
$intListID = 0;

// Validate the user-submitted form data before proceding
if (validateUserData()) {
// First, we'll be posting data to the contacts collection resource to create a new contact.
// Set some configuration variables specific to the task at hand.
$strResource = 'contacts';
$strData = '{
"data":{
"contact_name":"' . $_POST['name'] . '",
"contact_email":"' . $_POST['email'] . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);

// Make sure we successfully added the contact before continuing
if ($intListID > 0 && $arrResponse['status'] == 200) {
// Next, we'll be posting data to the lists/ID/contacts collection resource to associate the new contact with the specified distribution list.
// Set some configuration variables specific to the task at hand.
$strResource = 'lists/' . $intListID . '/contacts';
$strData = '{
"data":{
"contact_id":"' . $arrResponse['body'][0]->contact_id . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);
}

// Get a status message to diplay to the user.
$strMessage = getStatusMessage($arrResponse['status']);
} else {
// Send a message to the user explaining wehat they have done wrong.
// Your validateUserData() function should probably provide detailed error messages.
$strMessage = 'You must provide valid information. Please try again.';
}

// Function for validating the user-submitted form data
function validateUserData() {
// You'll probably want to put some code here to validate whatever input you're receiving from the user.
return true;
}

// Make an API POST request
function doAPIPost($strResourcePath, $strData) {
// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, API_USERNAME . ':' . API_PASSWORD);
curl_setopt($ch, CURLOPT_URL, API_BASEURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . API_FORMAT, 'Content-type: ' . API_FORMAT));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and capture the response and status code.
$arrResponse['body'] = json_decode(curl_exec($ch));
$arrResponse['status'] = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// Close the cURL resource
curl_close($ch);

return $arrResponse;
}

// Return a status message to display to the user.
function getStatusMessage($strStatus) {
// An array of all status codes.
// These descriptions are rather technical. You may want to make them more user-friendly for production.
$arrStatuses = array(
'200' => 'The request was successfully processed.',
'204' => 'The request was formatted correctly, but no data was found for the specified resource.',
'400' => 'Your data has failed a validation test.',
'401' => 'Either your username or password are incorrect, or you are attempting to access a resource that is not available for your user type.',
'404' => 'The resource you have requested does not exist.',
'405' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) is not allowed for the resource you have requested.',
'500' => 'The API experienced an internal error while attempting to process your request.',
'501' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) has not yet been implemented, but may be in a future release.'
);
// Look up the message that corresponds to the status code
if (array_key_exists($strStatus, $arrStatuses)) {
$strMessage = $arrStatuses[$strStatus];
} else {
// Use a default message if no match was found
$strMessage = 'An unknown error occurred while attempting to add your information. Please try again.';
}
return $strMessage;
}
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<?php echo $strMessage ?>
</body>
</html>
</source>

Sample Applications

WikiSysop — Fri, 05 Oct 2012 12:56:13 GMT

WikiSysop:

Below are sample applications built using the API, coded using PHP. These samples demonstrate a variety of common use cases. While we do not cover every possible use of the API here, these samples are meant to be indicative of all API calls.

All examples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any method that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Sample 1: mailing list signup form ==
This application allows a site visitor to add himself or herself to a an agent's contact list, while also adding the new contact to a predefined distribution list. The application consists of two files: an HTML file containing a simple signup form, and a PHP file which processes form submissions and makes the necessary API calls.

=== form.html ===
The form contains two fields: name, and email address. Hows=ever, this could be expanded to include any of the fields supported by the contacts collection resource.
<source lang="html4strict">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<h1>Add a Contact</h1>
<form action="form_processor.php" method="post" name="addcontactform" id="addcontactform">
<div>
<label for="name">Name:</label>
<input type="text" name="name" id="name" value="" />
</div>
<div>
<label for="email">Email address:</label>
<input type="text" name="email" id="email" value="" />
</div>
<div>
<input type="submit" value="Submit" />
</div>
</form>
</body>
</html>
</source>

=== form_processor.php ===
<source lang="php">
<?php
/*
* This script uses the Rezora Agent API to add a new contact entry to an agent's account,
* and to add that contact to a specified Distribution List so that newly added contacts
* may be easily identified by the agent from within the Rezora system.
* See http://api.rezora.com/ for the full API documentation.
*/

// Set some configuration constants.
// Your Agent API Key username and password are available on your Rezora My Account page.
define('API_USERNAME', 'YOUR_API_USERNAME');
define('API_PASSWORD', 'YOUR_API_PASSWORD');
define('API_BASEURI', 'http://api.rezora.com/v1/');
define('API_FORMAT', 'application/json');

// Set the ID of the distribution list to which new contacts will be added.
// You should create a distribution list (called something like "Website Signup") exclusively for this purpose.
// You can get the ID of a lsit by using the Lists API Resource, or by noting the ID in the HTML code on the agent's Contacts page within the Rezora system.
// Leave the value as zero to skip this step (not recommended).
$intListID = 0;

// Validate the user-submitted form data before proceding
if (validateUserData()) {
// First, we'll be posting data to the contacts collection resource to create a new contact.
// Set some configuration variables specific to the task at hand.
$strResource = 'contacts';
$strData = '{
"data":{
"contact_name":"' . $_POST['name'] . '",
"contact_email":"' . $_POST['email'] . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);

// Make sure we successfully added the contact before continuing
if ($intListID > 0 && $arrResponse['status'] == 200) {
// Next, we'll be posting data to the lists/ID/contacts collection resource to associate the new contact with the specified distribution list.
// Set some configuration variables specific to the task at hand.
$strResource = 'lists/' . $intListID . '/contacts';
$strData = '{
"data":{
"contact_id":"' . $arrResponse['body'][0]->contact_id . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);
}

// Get a status message to diplay to the user.
$strMessage = getStatusMessage($arrResponse['status']);
} else {
// Send a message to the user explaining wehat they have done wrong.
// Your validateUserData() function should probably provide detailed error messages.
$strMessage = 'You must provide valid information. Please try again.';
}

// Function for validating the user-submitted form data
function validateUserData() {
// You'll probably want to put some code here to validate whatever input you're receiving from the user.
return true;
}

// Make an API POST request
function doAPIPost($strResourcePath, $strData) {
// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, API_USERNAME . ':' . API_PASSWORD);
curl_setopt($ch, CURLOPT_URL, API_BASEURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . API_FORMAT, 'Content-type: ' . API_FORMAT));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and capture the response and status code.
$arrResponse['body'] = json_decode(curl_exec($ch));
$arrResponse['status'] = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// Close the cURL resource
curl_close($ch);

return $arrResponse;
}

// Return a status message to display to the user.
function getStatusMessage($strStatus) {
// An array of all status codes.
// These descriptions are rather technical. You may want to make them more user-friendly for production.
$arrStatuses = array(
'200' => 'The request was successfully processed.',
'204' => 'The request was formatted correctly, but no data was found for the specified resource.',
'400' => 'Your data has failed a validation test.',
'401' => 'Either your username or password are incorrect, or you are attempting to access a resource that is not available for your user type.',
'404' => 'The resource you have requested does not exist.',
'405' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) is not allowed for the resource you have requested.',
'500' => 'The API experienced an internal error while attempting to process your request.',
'501' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) has not yet been implemented, but may be in a future release.'
);
// Look up the message that corresponds to the status code
if (array_key_exists($strStatus, $arrStatuses)) {
$strMessage = $arrStatuses[$strStatus];
} else {
// Use a default message if no match was found
$strMessage = 'An unknown error occurred while attempting to add your information. Please try again.';
}
return $strMessage;
}
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<?php echo $strMessage ?>
</body>
</html>
</source>

Sample Applications

WikiSysop — Fri, 05 Oct 2012 12:50:57 GMT

WikiSysop:

Below are sample applications built using the API, coded using PHP. These samples demonstrate a variety of common use cases. While we do not cover every possible use of the API here, these samples are meant to be indicative of all API calls.

All examples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any method that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Sample 1: mailing list signup form ==
This application allows a site visitor to add himself or herself to a an agent's contact list, while also adding the new contact to a predefined distribution list. The application consists of two files: an HTML file containing a simple signup form, and a PHP file which processes form submissions and makes the necessary API calls.
<source lang="html4strict">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<h1>Add a Contact</h1>
<form action="form_processor.php" method="post" name="addcontactform" id="addcontactform">
<div>
<label for="name">Name:</label>
<input type="text" name="name" id="name" value="" />
</div>
<div>
<label for="email">Email address:</label>
<input type="text" name="email" id="email" value="" />
</div>
<div>
<input type="submit" value="Submit" />
</div>
</form>
</body>
</html>
</source>
<source lang="php">
<?php
/*
* This script uses the Rezora Agent API to add a new contact entry to an agent's account,
* and to add that contact to a specified Distribution List so that newly added contacts
* may be easily identified by the agent from within the Rezora system.
* See http://api.rezora.com/ for the full API documentation.
*/

// Set some configuration constants.
// Your Agent API Key username and password are available on your Rezora My Account page.
define('API_USERNAME', 'YOUR_API_USERNAME');
define('API_PASSWORD', 'YOUR_API_PASSWORD');
define('API_BASEURI', 'http://api.rezora.com/v1/');
define('API_FORMAT', 'application/json');

// Set the ID of the distribution list to which new contacts will be added.
// You should create a distribution list (called something like "Website Signup") exclusively for this purpose.
// You can get the ID of a lsit by using the Lists API Resource, or by noting the ID in the HTML code on the agent's Contacts page within the Rezora system.
// Leave the value as zero to skip this step (not recommended).
$intListID = 0;

// Validate the user-submitted form data before proceding
if (validateUserData()) {
// First, we'll be posting data to the contacts collection resource to create a new contact.
// Set some configuration variables specific to the task at hand.
$strResource = 'contacts';
$strData = '{
"data":{
"contact_name":"' . $_POST['name'] . '",
"contact_email":"' . $_POST['email'] . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);

// Make sure we successfully added the contact before continuing
if ($intListID > 0 && $arrResponse['status'] == 200) {
// Next, we'll be posting data to the lists/ID/contacts collection resource to associate the new contact with the specified distribution list.
// Set some configuration variables specific to the task at hand.
$strResource = 'lists/' . $intListID . '/contacts';
$strData = '{
"data":{
"contact_id":"' . $arrResponse['body'][0]->contact_id . '"
}
}';

// Post the API request
$arrResponse = doAPIPost($strResource, $strData);
}

// Get a status message to diplay to the user.
$strMessage = getStatusMessage($arrResponse['status']);
} else {
// Send a message to the user explaining wehat they have done wrong.
// Your validateUserData() function should probably provide detailed error messages.
$strMessage = 'You must provide valid information. Please try again.';
}

// Function for validating the user-submitted form data
function validateUserData() {
// You'll probably want to put some code here to validate whatever input you're receiving from the user.
return true;
}

// Make an API POST request
function doAPIPost($strResourcePath, $strData) {
// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, API_USERNAME . ':' . API_PASSWORD);
curl_setopt($ch, CURLOPT_URL, API_BASEURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . API_FORMAT, 'Content-type: ' . API_FORMAT));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and capture the response and status code.
$arrResponse['body'] = json_decode(curl_exec($ch));
$arrResponse['status'] = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// Close the cURL resource
curl_close($ch);

return $arrResponse;
}

// Return a status message to display to the user.
function getStatusMessage($strStatus) {
// An array of all status codes.
// These descriptions are rather technical. You may want to make them more user-friendly for production.
$arrStatuses = array(
'200' => 'The request was successfully processed.',
'204' => 'The request was formatted correctly, but no data was found for the specified resource.',
'400' => 'Your data has failed a validation test.',
'401' => 'Either your username or password are incorrect, or you are attempting to access a resource that is not available for your user type.',
'404' => 'The resource you have requested does not exist.',
'405' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) is not allowed for the resource you have requested.',
'500' => 'The API experienced an internal error while attempting to process your request.',
'501' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) has not yet been implemented, but may be in a future release.'
);
// Look up the message that corresponds to the status code
if (array_key_exists($strStatus, $arrStatuses)) {
$strMessage = $arrStatuses[$strStatus];
} else {
// Use a default message if no match was found
$strMessage = 'An unknown error occurred while attempting to add your information. Please try again.';
}
return $strMessage;
}
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Rezora API Sample: Add a Contact</title>
</head>
<body>
<?php echo $strMessage ?>
</body>
</html>
</source>

Sample Applications

WikiSysop — Fri, 05 Oct 2012 12:50:26 GMT

WikiSysop:

Sample Applications

WikiSysop — Fri, 05 Oct 2012 12:41:36 GMT

WikiSysop:

Sample Applications

WikiSysop — Fri, 05 Oct 2012 12:40:51 GMT

WikiSysop:

Sample Applications

WikiSysop — Fri, 05 Oct 2012 12:40:16 GMT

WikiSysop:

Sample Applications

WikiSysop — Fri, 05 Oct 2012 12:35:44 GMT

WikiSysop: Created page with 'Below are sample applications built using the API, coded using PHP. These samples demonstrate a variety of common use cases. While we do not cover every possible use of the API h…'

MediaWiki:Sidebar

WikiSysop — Fri, 05 Oct 2012 04:40:28 GMT

WikiSysop:

MediaWiki:Sidebar

WikiSysop — Fri, 05 Oct 2012 04:39:44 GMT

WikiSysop:

Code Examples

WikiSysop — Thu, 01 Mar 2012 16:50:14 GMT

WikiSysop: Undo revision 1191 by AngelSlayerL0AZ (Talk)

Below are examples of how to access the API using PHP. These examples demonstrate a variety of available methods and content formats. While we do not cover every possible use of the API here, these examples are meant to be indicative of all API calls.

All examples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any means that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Example 1: read the ''agents'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be reading data from the agents collection
// resource. We'll retrieve the data in CSV format.
$strResourcePath = 'agents';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'text/csv';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 2: read the ''agents/ID'' resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be reading data from the resource for
// an agent with the ID 1234. We'll retrieve the data in XML format.
// Notice that the presence of the .xml extension will override the
// Accept header value ($strResponseFormat). Alternatively, you
// could leave off the extension and set the Accept header value
// ($strResponseFormat) to application/xml.
$strResourcePath = 'agents/1234.xml';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'text/csv';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 3: add a new contact to the ''contacts'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be posting data to the contacts collection
// resource to create a new contact. We'll send data in JSON format,
// and retrieve data in XML format.
$strResourcePath = 'contacts';
$strRequestFormat = 'application/json';
$strResponseFormat = 'application/xml';
$strData = '{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 4: update an individual contact from the ''contacts/ID'' resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be updating data for an existing contact resource.
// We'll send data in XML format, and retrieve data in CSV format.
$strResourcePath = 'contacts/123456';
$strRequestFormat = 'application/xml';
$strResponseFormat = 'text/csv';
$strData = '<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith-Johnson</contact_name>
<contact_email>jane.smith.johnson@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// PUT is originally intended for uploading files,
// so we have to make our data look like a file.
// Open a file resource using the php://memory stream
$fh = fopen('php://memory', 'rw');

// Write the data to the file
fwrite($fh, $strData);

// Move back to the beginning of the file
rewind($fh);

// Make this a PUT request
curl_setopt($ch, CURLOPT_PUT, true);
curl_setopt($ch, CURLOPT_INFILE, $fh);
curl_setopt($ch, CURLOPT_INFILESIZE, strlen($strData));

// Make the request and output the response.
echo curl_exec($ch);

// Close the file resource
fclose($fh);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 5: delete all contacts from the ''contacts'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be deleting data from the contacts collection
// resource. We'll retrieve the data in JSON format.
$strResourcePath = 'contacts';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'application/json';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a DELETE request
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

Code Examples

WikiSysop — Thu, 01 Mar 2012 16:49:51 GMT

WikiSysop: Undo revision 1341 by AngelSlayerL0AZ (Talk)

Below are examples of how to access the API using PHP. These examples demonstrate a variety of available methods and content formats. While we do not cover every possible use of the API here, these examples are meant to be indicative of all API calls.

All examples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any means that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Example 1: read the ''agents'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be reading data from the agents collection
// resource. We'll retrieve the data in CSV format.
$strResourcePath = 'agents';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'text/csv';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 2: read the ''agents/ID'' resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be reading data from the resource for
// an agent with the ID 1234. We'll retrieve the data in XML format.
// Notice that the presence of the .xml extension will override the
// Accept header value ($strResponseFormat). Alternatively, you
// could leave off the extension and set the Accept header value
// ($strResponseFormat) to application/xml.
$strResourcePath = 'agents/1234.xml';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'text/csv';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 3: add a new contact to the ''contacts'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be posting data to the contacts collection
// resource to create a new contact. We'll send data in JSON format,
// and retrieve data in XML format.
$strResourcePath = 'contacts';
$strRequestFormat = 'application/json';
$strResponseFormat = 'application/xml';
$strData = '{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . EssaysExperts.Com is the company which first and main priority was, is and will be customers� satisfaction with the [http://www.essaysexperts.com essays online]. If you still have no idea where to buy your writing tasks, this company is the best option for you. ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 4: update an individual contact from the ''contacts/ID'' resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be updating data for an existing contact resource.
// We'll send data in XML format, and retrieve data in CSV format.
$strResourcePath = 'contacts/123456';
$strRequestFormat = 'application/xml';
$strResponseFormat = 'text/csv';
$strData = '<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith-Johnson</contact_name>
<contact_email>jane.smith.johnson@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// PUT is originally intended for uploading files,
// so we have to make our data look like a file.
// Open a file resource using the php://memory stream
$fh = fopen('php://memory', 'rw');

// Write the data to the file
fwrite($fh, $strData);

// Move back to the beginning of the file
rewind($fh);

// Make this a PUT request
curl_setopt($ch, CURLOPT_PUT, true);
curl_setopt($ch, CURLOPT_INFILE, $fh);
curl_setopt($ch, CURLOPT_INFILESIZE, strlen($strData));

// Make the request and output the response.
echo curl_exec($ch);

// Close the file resource
fclose($fh);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 5: delete all contacts from the ''contacts'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be deleting data from the contacts collection
// resource. We'll retrieve the data in JSON format.
$strResourcePath = 'contacts';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'application/json';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a DELETE request
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

Code Examples

WikiSysop — Thu, 01 Mar 2012 16:46:52 GMT

WikiSysop: Reverted edits by AngelSlayerL0AZ (Talk) to last revision by WikiSysop

Below are examples of how to access the API using PHP. These examples demonstrate a variety of available methods and content formats. While we do not cover every possible use of the API here, these examples are meant to be indicative of all API calls.

All examples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any means that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Example 1: read the ''agents'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be reading data from the agents collection
// resource. We'll retrieve the data in CSV format.
$strResourcePath = 'agents';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'text/csv';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 2: read the ''agents/ID'' resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be reading data from the resource for
// an agent with the ID 1234. We'll retrieve the data in XML format.
// Notice that the presence of the .xml extension will override the
// Accept header value ($strResponseFormat). Alternatively, you
// could leave off the extension and set the Accept header value
// ($strResponseFormat) to application/xml.
$strResourcePath = 'agents/1234.xml';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'text/csv';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 3: add a new contact to the ''contacts'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be posting data to the contacts collection
// resource to create a new contact. We'll send data in JSON format,
// and retrieve data in XML format.
$strResourcePath = 'contacts';
$strRequestFormat = 'application/json';
$strResponseFormat = 'application/xml';
$strData = '{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . EssaysExperts.Com is the company which first and main priority was, is and will be customers� satisfaction with the [http://www.essaysexperts.com essays online]. EssaysExperts.Com is the company which first and main priority was, is and will be customers� satisfaction with the [http://www.essaysexperts.com/essays-online.html essays online]. If you still have no idea where to buy your writing tasks, this company is the best option for you. If you still have no idea where to buy your writing tasks, this company is the best option for you. ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 4: update an individual contact from the ''contacts/ID'' resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be updating data for an existing contact resource.
// We'll send data in XML format, and retrieve data in CSV format.
$strResourcePath = 'contacts/123456';
$strRequestFormat = 'application/xml';
$strResponseFormat = 'text/csv';
$strData = '<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith-Johnson</contact_name>
<contact_email>jane.smith.johnson@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// PUT is originally intended for uploading files,
// so we have to make our data look like a file.
// Open a file resource using the php://memory stream
$fh = fopen('php://memory', 'rw');

// Write the data to the file
fwrite($fh, $strData);

// Move back to the beginning of the file
rewind($fh);

// Make this a PUT request
curl_setopt($ch, CURLOPT_PUT, true);
curl_setopt($ch, CURLOPT_INFILE, $fh);
curl_setopt($ch, CURLOPT_INFILESIZE, strlen($strData));

// Make the request and output the response.
echo curl_exec($ch);

// Close the file resource
fclose($fh);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 5: delete all contacts from the ''contacts'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be deleting data from the contacts collection
// resource. We'll retrieve the data in JSON format.
$strResourcePath = 'contacts';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'application/json';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a DELETE request
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

Common Behaviors

WikiSysop — Thu, 01 Mar 2012 14:20:36 GMT

WikiSysop: Reverted edits by Zhyaoxiaiw (Talk) to last revision by WikiSysop

== Access Permissions ==
Accessing the API requires a username and password, provided by Rezora. Note that this is not the same as your username and password to the Rezora system itself. To obtain a username and password, contact your Rezora Account Manager.

There are two distinct levels of access to the API, which correspond to user types on the Rezora system in general:
* Company-level
* Agent-level

API credentials for a company-level account only grant access to company-level resources, and credentials for an agent-level account only grant access to agent-level resources.

== Usage Limitations ==
Currently, there is no usage limit in place for the API. However, we do track usage, and reserve the right to institute limitations in the future. In the mean time, we ask that you develop your applications in such a way as to make the fewest API calls necessary to accomplish your goals, and to spread out the calls over time. Your consideration is appreciated.

== URI (Uniform Resource Identifier) ==
The Rezora REST API uses the URI to identify the resource you are attempting to consume.

'''''URI Template:''''' PROTOCOL://DOMAIN/VERSION/RESOURCE_DESIGNATOR.RESPONSE_FORMAT

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/agents/1234.xml</nowiki>

The URI consists of the following components:

=== Protocol (required) ===
The API currently supports the basic HTTP protocol, but will likely switch to HTTPS in future versions to further ensure security.

'''''Example URI:''''' <big>'''http'''</big><nowiki>://api.rezora.com/v1/agents/1234.xml</nowiki>

=== Domain (required) ===
The domain of the API is expected to be permanent, and will not change with future versions.

'''''Example URI:''''' <nowiki>http://</nowiki><big>'''api.rezora.com'''</big>/v1/agents/1234.xml

=== Version (required) ===
The URI for the API includes a version indicator, used to specify the version of the API for which your application is programmed. This will allow us to continue to offer previous versions of the API without interruption as future versions are released.

'''''Example URI:''''' <nowiki>http://api.rezora.com/</nowiki><big>'''v1'''</big>/agents/1234.xml

=== Resource Designator (required) ===
The resource designator portion of the URI is the part which uniquely identifies the resource you wish to consume. It may be comprised of multiple components separated by forward slashes (/). For example, to reference the resource containing all agents in your brokerage, your resource designator would be "agents". To reference the resource for a specific agent, you would include the agent's ID in the resource designator: "agents/1234". URIs for all available resources are given on the individual [[Resource_Definitions|Resource Definition]] pages.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/</nowiki><big>'''agents/1234'''</big>.xml

=== Response Format (optional) ===
The response format indicator is an optional file extension added to the end of the [[Common_Behaviors#Resource_Designator_.28required.29|resource designator]]. Supported values are JSON, XML, and CSV. A response format indicator included in the URI will supersede the value of an ACCEPT header (described below), if present. If no response format indicator is included in the URI, and no [[Common_Behaviors#Accept_.28required.29|ACCEPT header]] is included with the request, the response format will default to CSV.
'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/agents/1234.</nowiki><big>'''xml'''</big>

== HTTP Request Headers ==
The Rezora REST API makes use of several headers sent with the HTTP request for such purposes as authentication, indicating what action is to be taken with the resource specified in the URI, and indicating in what format the data will take in both the request and response.

'''''Example Request:'''''
GET /v1/agents/1234.xml HTTP/1.1
Authorization: Digest username="YOUR_USERNAME", realm="Rezora API", nonce="4c487da82df10",
uri="/v1/agents/1234.xml", cnonce="MjMxATNz", nc=00000001, qop="auth",
response="a6767615fab72a0c9d64d4b01df69db2", opaque="e24302732637d79c3b77fa62483ec0b7"
Host: api.rezora.com
Accept: text/csv
Content-type: text/plain

The API makes use of the following headers:

=== Method (required) ===
The Rezora REST API makes use of the standard HTTP methods (GET, POST, PUT, and DELETE) to determine the action you wish to perform with the resource you have specified in the URI. Note that not all resources will support all four methods. The actions associated with each method are as follows:
;GET
: A request sent using the HTTP GET method is used to retrieve or read the data for the specified resource.
;POST
: A request sent using the HTTP POST method is used to create a new resource of the type specified in the URI.
;PUT
: A request sent using the HTTP PUT method is used to update an existing resource, as specified in the URI.
;DELETE
: A request sent using the HTTP DELETE method is used to delete the resource indicated in the URI.

=== Authorization (required) ===
The Rezora REST API uses HTTP digest access authentication to validate your username and password before providing access to the requested resource.

=== Accept (required) ===
The HTTP ACCEPT header is used to specify the desired format of the response data from the API. The available options are application/xml, application/xml, and text/csv. This option is overridden by the presence of a [[Common_Behaviors#Response_Format_.28optional.29|response format indicator (file extension)]] in the URI.

=== Content-type (required) ===
The HTTP CONTENT-TYPE header is used to specify the format of data being sent as part of the request. The available options are application/xml, application/xml, and text/plain. Note that, while the Content-type header is required for all request methods, data is only sent with POST and PUT requests.

== HTTP Response Headers ==
The Rezora REST API provides useful information in several headers sent with the HTTP response.

'''''Example Response Headers:'''''
HTTP/1.1 200 OK
Date: Sun, 11 Jul 2010 23:00:10 GMT
Server: Apache/2.2.12 (Ubuntu)
X-Powered-By: PHP/5.2.10-2ubuntu6.4
Set-Cookie: PHPSESSID=e3a81e530b701165d368b77c9ddc6ab6; path=/
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: no-cache
Transfer-Encoding: chunked
Content-Type: text/csv; charset=UTF-8

=== Status ===
The first line of the HTTP headers includes a numeric code, which is used to indicate the status of your request.

'''''Example Status Header:'''''
HTTP/1.1 200 OK

A list of status codes used by the API and their meanings is provided below.

==== Status Codes ====
;200
: The request was successfully processed.
;204
: The request was formatted correctly, but no data was found for the specified resource.
;400
: Your data has failed a validation test.
;401
: Either your username or password are incorrect, or you are attempting to access a resource that is not available for your user type.
;404
: The resource you have requested does not exist.
;405
: The method you are attempting to use (GET, POST, PUT, or DELETE) is not allowed for the resource you have requested.
;500
: The API experienced an internal error while attempting to process your request.
;501
: The method you are attempting to use (GET, POST, PUT, or DELETE) has not yet been implemented, but may be in a future release.

=== Content-type ===
The HTTP CONTENT-TYPE header is used to indicate the format of data being sent as part of the response. The format is determined by either the [[Common_Behaviors#Accept_.28required.29|ACCEPT HTTP request header]] or the [[Common_Behaviors#Response_Format_.28optional.29|response format indicator (file extension)]] in the request URI. If no ACCEPT header or response format indicator are present in the request, the default response format is text/csv.

'''''Example Header:'''''
Content-Type: text/csv; charset=UTF-8

== About Output Data ==
All dates are displayed as UTC (GMT), unless otherwise noted. All output data is UTF-8 encoded. Data in JSON and XML formats follow the standard rules of escaping reserved characters, encoding entities, etc. as indicated by their respective standards. As there is no standard for the CSV format, here are the formatting rules we are using for our output:

* '''Field delimiter:''' |
* '''Line terminator:''' \r\n
* '''Quoting:''' all fields are quoted
* '''Quote character:''' "
* '''Escape Character:''' \

Code Examples

WikiSysop — Wed, 08 Feb 2012 01:12:56 GMT

WikiSysop:

Below are examples of how to access the API using PHP. These examples demonstrate a variety of available methods and content formats. While we do not cover every possible use of the API here, these examples are meant to be indicative of all API calls.

All examples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any means that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Example 1: read the ''agents'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be reading data from the agents collection
// resource. We'll retrieve the data in CSV format.
$strResourcePath = 'agents';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'text/csv';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 2: read the ''agents/ID'' resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be reading data from the resource for
// an agent with the ID 1234. We'll retrieve the data in XML format.
// Notice that the presence of the .xml extension will override the
// Accept header value ($strResponseFormat). Alternatively, you
// could leave off the extension and set the Accept header value
// ($strResponseFormat) to application/xml.
$strResourcePath = 'agents/1234.xml';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'text/csv';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 3: add a new contact to the ''contacts'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be posting data to the contacts collection
// resource to create a new contact. We'll send data in JSON format,
// and retrieve data in XML format.
$strResourcePath = 'contacts';
$strRequestFormat = 'application/json';
$strResponseFormat = 'application/xml';
$strData = '{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . EssaysExperts.Com is the company which first and main priority was, is and will be customers� satisfaction with the [http://www.essaysexperts.com essays online]. EssaysExperts.Com is the company which first and main priority was, is and will be customers� satisfaction with the [http://www.essaysexperts.com/essays-online.html essays online]. If you still have no idea where to buy your writing tasks, this company is the best option for you. If you still have no idea where to buy your writing tasks, this company is the best option for you. ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 4: update an individual contact from the ''contacts/ID'' resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be updating data for an existing contact resource.
// We'll send data in XML format, and retrieve data in CSV format.
$strResourcePath = 'contacts/123456';
$strRequestFormat = 'application/xml';
$strResponseFormat = 'text/csv';
$strData = '<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith-Johnson</contact_name>
<contact_email>jane.smith.johnson@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// PUT is originally intended for uploading files,
// so we have to make our data look like a file.
// Open a file resource using the php://memory stream
$fh = fopen('php://memory', 'rw');

// Write the data to the file
fwrite($fh, $strData);

// Move back to the beginning of the file
rewind($fh);

// Make this a PUT request
curl_setopt($ch, CURLOPT_PUT, true);
curl_setopt($ch, CURLOPT_INFILE, $fh);
curl_setopt($ch, CURLOPT_INFILESIZE, strlen($strData));

// Make the request and output the response.
echo curl_exec($ch);

// Close the file resource
fclose($fh);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 5: delete all contacts from the ''contacts'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be deleting data from the contacts collection
// resource. We'll retrieve the data in JSON format.
$strResourcePath = 'contacts';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'application/json';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a DELETE request
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

Resource Definitions:MLSs/ID

WikiSysop — Wed, 08 Feb 2012 01:10:29 GMT

WikiSysop: Created page with 'The ''mlss/ID'' resource references an individual MLS, where "ID" is the MLS's unique identifier within the Rezora system. '''''Example URI:''''' <nowiki>http://api.rezora.com/…'

The ''mlss/ID'' resource references an individual MLS, where "ID" is the MLS's unique identifier within the Rezora system.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/mlss/comlmls</nowiki>

Available methods are:

== GET ==

Returns a list of account settings for the specified agent. The response includes the following fields:
* org_id
* mls_name

=== Example Response - XML ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<mlss version="1.0">
<mls>
<org_id>comlmls</org_id>
<mls_name>Colorado - Metrolist</mls_name>
</mls>
</mlss>
</source>

=== Example Response - JSON ===
<source lang="javascript">
[
{
"org_id":"comlmls",
"mls_name":"Colorado - Metrolist"
}
]
</source>

=== Example Response - CSV ===
<div style="overflow: auto;">
<source lang="text">
"org_id"|"mls_name"
"comlmls"|"Colorado - Metrolist"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]

Resource Definitions:MLSs

WikiSysop — Wed, 08 Feb 2012 01:05:00 GMT

WikiSysop:

The ''MLSs'' resource is a collection of all MLSs associated with your company.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/mlss</nowiki>

Available methods are:

== GET ==
Returns a list of MLSs. Each MLS record includes the following fields:

* org_id
* mls_name

=== Example Response - XML ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<mlss version="1.0">
<mls>
<org_id>comlmls</org_id>
<mls_name>Colorado - Metrolist</mls_name>
</mls>
...
</mlss>
</source>

=== Example Response - JSON ===
<source lang="javascript">
[
{
"org_id":"comlmls",
"mls_name":"Colorado - Metrolist"
},
...
]
</source>

=== Example Response - CSV ===
<div style="overflow: auto;">
<source lang="text">
"org_id"|"mls_name"
"comlmls"|"Colorado - Metrolist"
...
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]

Resource Definitions:MLSs

WikiSysop — Wed, 08 Feb 2012 00:52:06 GMT

WikiSysop: Created page with 'test'

test

Resource Definitions

WikiSysop — Wed, 08 Feb 2012 00:51:44 GMT

WikiSysop: /* Company Resources */

This section defines the resources made available through the API. These include descriptions of the resource, a list of the methods supported, a list of the the data fields contained in the resource, and sample request and response data, where appropriate. The resources below are grouped into two sets, based on the type of user allowed to access them. The available resources are:

== Company Resources ==
* [[Resource_Definitions:Agents|Agents]]
* [[Resource_Definitions:Agents/ID|Agents/ID]]
* [[Resource_Definitions:Groups|Groups]]
* [[Resource_Definitions:Groups/ID|Groups/ID]]
* [[Resource_Definitions:Groups/ID/Agents|Groups/ID/Agents]]
* [[Resource_Definitions:Groups/ID/Agents/ID|Groups/ID/Agents/ID]]
* [[Resource_Definitions:MLSs|MLSs]]
* [[Resource_Definitions:MLSs/ID|MLSs/ID]]

== Agent Resources ==
* [[Resource_Definitions:Contacts|Contacts]]
* [[Resource_Definitions:Contacts/ID|Contacts/ID]]
* [[Resource_Definitions:Lists|Lists]]
* [[Resource_Definitions:Lists/ID|Lists/ID]]
* [[Resource_Definitions:Lists/ID/Contacts|Lists/ID/Contacts]]
* [[Resource_Definitions:Lists/ID/Contacts/ID|Lists/ID/Contacts/ID]]

Resource Definitions:Contacts

WikiSysop — Fri, 03 Feb 2012 21:48:46 GMT

WikiSysop:

The ''contacts'' resource is a collection of all contacts associated with your agent account.

Each agent account has one special contact, known as the "self contact." This contact has a contact_self value of 1, while all other contacts have a contact_self value of 0. The self contact cannot be deleted. The delete all functionality deletes all contacts with a contact_self value of 0, but leaves the self contact intact.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/contacts</nowiki>

Available methods are:

== GET ==
Returns a list of contacts. Each contact record includes the following fields:

* contact_id
* contact_name
* contact_email
* contact_type - ''possible values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip
* contact_date
* contact_self - ''possible values: 0, 1 (cannot delete)''
* contact_unsubscribe - ''possible values: 0 (subscribed), 1 (unsubscribed)''

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<contact_id>123456</contact_id>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
<contact_date>2010-07-16 22:34:01</contact_date>
<contact_self>0</contact_self>
<contact_unsubscribe>0</contact_unsubscribe>
</contact>
...
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contact_id":"123456",
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345",
"contact_date":"2010-07-16 22:34:01",
"contact_self":"0",
"contact_unsubscribe":"0"
}
...
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contact_id"|"contact_name"|"contact_email"|"contact_type"|"contact_title"|"contact_company"|"contact_phone_home"|"contact_phone_work"|"contact_phone_mobile"|"contact_phone_fax"|"contact_business_street"|"contact_business_street2"|"contact_business_city"|"contact_business_state"|"contact_business_zip"|"contact_home_street"|"contact_home_street2"|"contact_home_city"|"contact_home_state"|"contact_home_zip"|"contact_date"|"contact_self"
"123456"|"Jane Smith"|"jane.smith@company.com"|"Active"|"Consultant"|"Acme Consulting"|"303-555-1234"|"303-555-1235"|"303-555-1236"|"303-555-1237"|"123 Church Street"|"Suite 12"|"Shady Acres"|"CO"|"12345"|"124 Church Street"|""|"Shady Acres"|"CO"|"12345"|"2010-07-16 22:34:01"|"0"|"0"
...
</source>
</div>

== POST ==
Adds a new contact, and returns the new contact ID. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* contact_name
* contact_email '''<span style="color: #f00;">*</span>''' - ''must be a valid email address, must be unique''
* contact_type - ''accepted values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
contact_name=Jane+Smith&contact_email=jane.smith%40company.com&contact_type=Active&contact_title=Consultant&contact_company=Acme+Consulting&contact_phone_home=303-555-1234&contact_phone_work=303-555-1235&contact_phone_mobile=303-555-1236&contact_phone_fax=303-555-1237&contact_business_street=123+Church+Street&contact_business_street2=Suite+12&contact_business_city=Shady+Acres&contact_business_state=CO&contact_business_zip=12345&contact_home_street=124+Church+Street&contact_home_street2=&contact_home_city=Shady+Acres&contact_home_state=CO&contact_home_zip=12345
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<contact_id>123456</contact_id>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contact_id":"123456"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contact_id"
"123456"
</source>
</div>

== DELETE ==
Permanently removes ALL contacts (except for the self contact), and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<status>200</status>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Contacts

WikiSysop — Fri, 03 Feb 2012 21:40:37 GMT

WikiSysop: /* JSON Response */

The ''contacts'' resource is a collection of all contacts associated with your agent account.

Each agent account has one special contact, known as the "self contact." This contact has a contact_self value of 1, while all other contacts have a contact_self value of 0. The self contact cannot be deleted. The delete all functionality deletes all contacts with a contact_self value of 0, but leaves the self contact in tact.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/contacts</nowiki>

Available methods are:

== GET ==
Returns a list of contacts. Each contact record includes the following fields:

* contact_id
* contact_name
* contact_email
* contact_type - ''possible values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip
* contact_date
* contact_self - ''possible values: 0, 1 (cannot delete)''
* contact_unsubscribe - ''possible values: 0 (subscribed), 1 (unsubscribed)''

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<contact_id>123456</contact_id>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
<contact_date>2010-07-16 22:34:01</contact_date>
<contact_self>0</contact_self>
<contact_unsubscribe>0</contact_unsubscribe>
</contact>
...
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contact_id":"123456",
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345",
"contact_date":"2010-07-16 22:34:01",
"contact_self":"0",
"contact_unsubscribe":"0"
}
...
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contact_id"|"contact_name"|"contact_email"|"contact_type"|"contact_title"|"contact_company"|"contact_phone_home"|"contact_phone_work"|"contact_phone_mobile"|"contact_phone_fax"|"contact_business_street"|"contact_business_street2"|"contact_business_city"|"contact_business_state"|"contact_business_zip"|"contact_home_street"|"contact_home_street2"|"contact_home_city"|"contact_home_state"|"contact_home_zip"|"contact_date"|"contact_self"
"123456"|"Jane Smith"|"jane.smith@company.com"|"Active"|"Consultant"|"Acme Consulting"|"303-555-1234"|"303-555-1235"|"303-555-1236"|"303-555-1237"|"123 Church Street"|"Suite 12"|"Shady Acres"|"CO"|"12345"|"124 Church Street"|""|"Shady Acres"|"CO"|"12345"|"2010-07-16 22:34:01"|"0"|"0"
...
</source>
</div>

== POST ==
Adds a new contact, and returns the new contact ID. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* contact_name
* contact_email '''<span style="color: #f00;">*</span>''' - ''must be a valid email address, must be unique''
* contact_type - ''accepted values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
contact_name=Jane+Smith&contact_email=jane.smith%40company.com&contact_type=Active&contact_title=Consultant&contact_company=Acme+Consulting&contact_phone_home=303-555-1234&contact_phone_work=303-555-1235&contact_phone_mobile=303-555-1236&contact_phone_fax=303-555-1237&contact_business_street=123+Church+Street&contact_business_street2=Suite+12&contact_business_city=Shady+Acres&contact_business_state=CO&contact_business_zip=12345&contact_home_street=124+Church+Street&contact_home_street2=&contact_home_city=Shady+Acres&contact_home_state=CO&contact_home_zip=12345
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<contact_id>123456</contact_id>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contact_id":"123456"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contact_id"
"123456"
</source>
</div>

== DELETE ==
Permanently removes ALL contacts (except for the self contact), and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<status>200</status>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Contacts/ID

WikiSysop — Fri, 03 Feb 2012 21:39:39 GMT

WikiSysop: /* GET */

The ''contacts/ID'' resource is an individual contact entry associated with your agent account, where "ID" is the contact's contact_id number.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/contacts/123456</nowiki>

Available methods are:

== GET ==
Returns an individual contact. The contact record includes the following fields:

* contact_id
* contact_name
* contact_email
* contact_type - ''possible values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip
* contact_date
* contact_self - ''possible values: 0, 1 (cannot delete)''
* contact_unsubscribe - ''possible values: 0 (subscribed), 1 (unsubscribed)''

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<contact_id>123456</contact_id>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
<contact_date>2010-07-16 22:34:01</contact_date>
<contact_self>0</contact_self>
<contact_unsubscribe>0</contact_unsubscribe>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contact_id":"123456",
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345",
"contact_date":"2010-07-16 22:34:01",
"contact_self":"0",
"contact_unsubscribe":"0"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contact_id"|"contact_name"|"contact_email"|"contact_type"|"contact_title"|"contact_company"|"contact_phone_home"|"contact_phone_work"|"contact_phone_mobile"|"contact_phone_fax"|"contact_business_street"|"contact_business_street2"|"contact_business_city"|"contact_business_state"|"contact_business_zip"|"contact_home_street"|"contact_home_street2"|"contact_home_city"|"contact_home_state"|"contact_home_zip"|"contact_date"|"contact_self"
"123456"|"Jane Smith"|"jane.smith@company.com"|"Active"|"Consultant"|"Acme Consulting"|"303-555-1234"|"303-555-1235"|"303-555-1236"|"303-555-1237"|"123 Church Street"|"Suite 12"|"Shady Acres"|"CO"|"12345"|"124 Church Street"|""|"Shady Acres"|"CO"|"12345"|"2010-07-16 22:34:01"|"0"|"0"
</source>
</div>

== PUT ==
Updates an existing contact, and returns a success code. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* contact_name
* contact_email '''<span style="color: #f00;">*</span>''' - ''must be a valid email address, must be unique''
* contact_type - ''possible values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
contact_name=Jane+Smith&contact_email=jane.smith%40company.com&contact_type=Active&contact_title=Consultant&contact_company=Acme+Consulting&contact_phone_home=303-555-1234&contact_phone_work=303-555-1235&contact_phone_mobile=303-555-1236&contact_phone_fax=303-555-1237&contact_business_street=123+Church+Street&contact_business_street2=Suite+12&contact_business_city=Shady+Acres&contact_business_state=CO&contact_business_zip=12345&contact_home_street=124+Church+Street&contact_home_street2=&contact_home_city=Shady+Acres&contact_home_state=CO&contact_home_zip=12345
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<status>200</status>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>

== DELETE ==
Permanently removes an individual contact, and returns a success code. Note the you CANNOT delete the self contact (contact_self = 1).

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<status>200</status>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Contacts

WikiSysop — Fri, 03 Feb 2012 21:36:19 GMT

WikiSysop: /* GET */

The ''contacts'' resource is a collection of all contacts associated with your agent account.

Each agent account has one special contact, known as the "self contact." This contact has a contact_self value of 1, while all other contacts have a contact_self value of 0. The self contact cannot be deleted. The delete all functionality deletes all contacts with a contact_self value of 0, but leaves the self contact in tact.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/contacts</nowiki>

Available methods are:

== GET ==
Returns a list of contacts. Each contact record includes the following fields:

* contact_id
* contact_name
* contact_email
* contact_type - ''possible values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip
* contact_date
* contact_self - ''possible values: 0, 1 (cannot delete)''
* contact_unsubscribe - ''possible values: 0 (subscribed), 1 (unsubscribed)''

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<contact_id>123456</contact_id>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
<contact_date>2010-07-16 22:34:01</contact_date>
<contact_self>0</contact_self>
<contact_unsubscribe>0</contact_unsubscribe>
</contact>
...
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contact_id":"123456",
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345",
"contact_date":"2010-07-16 22:34:01",
"contact_self":"0"
"contact_unsubscribe":"0"
}
...
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contact_id"|"contact_name"|"contact_email"|"contact_type"|"contact_title"|"contact_company"|"contact_phone_home"|"contact_phone_work"|"contact_phone_mobile"|"contact_phone_fax"|"contact_business_street"|"contact_business_street2"|"contact_business_city"|"contact_business_state"|"contact_business_zip"|"contact_home_street"|"contact_home_street2"|"contact_home_city"|"contact_home_state"|"contact_home_zip"|"contact_date"|"contact_self"
"123456"|"Jane Smith"|"jane.smith@company.com"|"Active"|"Consultant"|"Acme Consulting"|"303-555-1234"|"303-555-1235"|"303-555-1236"|"303-555-1237"|"123 Church Street"|"Suite 12"|"Shady Acres"|"CO"|"12345"|"124 Church Street"|""|"Shady Acres"|"CO"|"12345"|"2010-07-16 22:34:01"|"0"|"0"
...
</source>
</div>

== POST ==
Adds a new contact, and returns the new contact ID. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* contact_name
* contact_email '''<span style="color: #f00;">*</span>''' - ''must be a valid email address, must be unique''
* contact_type - ''accepted values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
contact_name=Jane+Smith&contact_email=jane.smith%40company.com&contact_type=Active&contact_title=Consultant&contact_company=Acme+Consulting&contact_phone_home=303-555-1234&contact_phone_work=303-555-1235&contact_phone_mobile=303-555-1236&contact_phone_fax=303-555-1237&contact_business_street=123+Church+Street&contact_business_street2=Suite+12&contact_business_city=Shady+Acres&contact_business_state=CO&contact_business_zip=12345&contact_home_street=124+Church+Street&contact_home_street2=&contact_home_city=Shady+Acres&contact_home_state=CO&contact_home_zip=12345
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<contact_id>123456</contact_id>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contact_id":"123456"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contact_id"
"123456"
</source>
</div>

== DELETE ==
Permanently removes ALL contacts (except for the self contact), and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<status>200</status>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Agents/ID

WikiSysop — Tue, 22 Nov 2011 20:58:09 GMT

WikiSysop: /* GET */

The ''agents/ID'' resource references an individual agent account, where "ID" is the agent's user_id number.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/agents/1234</nowiki>

Available methods are:

== GET ==

Returns a list of account settings for the specified agent. The response includes the following fields:
* user_id
* user_email
* user_status_id - ''possible values: 1 (active), 2 (suspended), 3 (trial), 4 (pending), 5 (free), 6 (deactivated)''
* user_fname
* user_lname
* user_company_name
* user_email_work
* user_website
* user_phone_work
* user_phone_home
* user_phone_mobile
* user_phone_fax
* user_photo_path
* user_home_street
* user_home_suite
* user_home_city
* user_home_state
* user_home_zip
* user_company_website
* user_company_street
* user_company_suite
* user_company_city
* user_company_state
* user_company_zip
* user_company_logo_path
* user_tagline
* user_bio
* user_date
* user_report_daily - ''possible values: 0, 1 (receives daily status email)''
* user_report_weekly - ''possible values: 0, 1 (receives weekly status email)''
* user_report_monthly - ''possible values: 0, 1 (receives monthly status email)''
* user_sitename
* user_directory_hidden - ''possible values: 0, 1 (not displayed on agent directory page)''
* brokerage_employee_id
* key_username

=== Example Response - XML ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<agents version="1.0">
<agent>
<user_id>1234</user_id>
<user_email>john.smith@company.com</user_email>
<user_status_id>1</user_status_id>
<user_fname>John</user_fname>
<user_lname>Smith</user_lname>
<user_company_name>Shady Acres Brokerage</user_company_name>
<user_email_work>john.smith@company.com</user_email_work>
<user_website>www.shadyacresbrokerage.com</user_website>
<user_phone_work>303-555-1234</user_phone_work>
<user_phone_home></user_phone_home>
<user_phone_mobile>303-555-1235</user_phone_mobile>
<user_phone_fax>303-555-1236</user_phone_fax>
<user_photo_path>1234_photo.jpg</user_photo_path>
<user_home_street>123 Main Street</user_home_street>
<user_home_suite></user_home_suite>
<user_home_city>Shady Acres</user_home_city>
<user_home_state>CO</user_home_state>
<user_home_zip>12345</user_home_zip>
<user_company_website>www.shadyacresbrokerage.com</user_company_website>
<user_company_street>124 Main Street</user_company_street>
<user_company_suite>5</user_company_suite>
<user_company_city>Shady Acres</user_company_city>
<user_company_state>CO</user_company_state>
<user_company_zip>12345</user_company_zip>
<user_company_logo_path>sab_logo.gif</user_company_logo_path>
<user_tagline></user_tagline>
<user_bio></user_bio>
<user_date>2009-07-13 11:25:23</user_date>
<user_report_daily>0</user_report_daily>
<user_report_weekly>1</user_report_weekly>
<user_report_monthly>0</user_report_monthly>
<user_sitename></user_sitename>
<user_directory_hidden>0</user_directory_hidden>
<brokerage_employee_id></brokerage_employee_id>
<key_username></key_username>
</agent>
</agents>
</source>

=== Example Response - JSON ===
<source lang="javascript">
[
{
"user_id":"1234",
"user_email":"john.smith@company.com",
"user_status_id":"1",
"user_fname":"John",
"user_lname":"Smith",
"user_company_name":"hady Acres Brokerage",
"user_email_work":"john.smith@company.com",
"user_website":"www.shadyacresbrokerage.com",
"user_phone_work":"303-555-1234",
"user_phone_home":"",
"user_phone_mobile":"303-555-1235",
"user_phone_fax":"303-555-1236",
"user_photo_path":"1234_photo.jpg",
"user_home_street":"123 Main Street",
"user_home_suite":"",
"user_home_city":"Shady Acres",
"user_home_state":"CO",
"user_home_zip":"12345",
"user_company_website":"www.shadyacresbrokerage.com",
"user_company_street":"124 Main Street",
"user_company_suite":"5",
"user_company_city":"Shady Acres",
"user_company_state":"CO",
"user_company_zip":"12345",
"user_company_logo_path":"sab_logo.gif",
"user_tagline":"",
"user_bio":"",
"user_date":"2009-07-13 11:25:23",
"user_report_daily":"0",
"user_report_weekly":"1",
"user_report_monthly":"0",
"user_sitename":"",
"user_directory_hidden":"0",
"brokerage_employee_id":"",
"key_username":""
}
]
</source>

=== Example Response - CSV ===
<div style="overflow: auto;">
<source lang="text">
"user_id"|"user_email"|"user_status_id"|"user_fname"|"user_lname"|"user_company_name"|"user_email_work"|"user_website"|"user_phone_work"|"user_phone_home"|"user_phone_mobile"|"user_phone_fax"|"user_photo_path"|"user_home_street"|"user_home_suite"|"user_home_city"|"user_home_state"|"user_home_zip"|"user_company_website"|"user_company_street"|"user_company_suite"|"user_company_city"|"user_company_state"|"user_company_zip"|"user_company_logo_path"|"user_tagline"|"user_bio"|"user_date"|"user_report_daily"|"user_report_weekly"|"user_report_monthly"|"user_sitename"|"user_directory_hidden"|"brokerage_employee_id"|"key_username"
"1234"|"john.smith@company.com"|"1"|"John"|"Smith"|"Shady Acres Brokerage"|"john.smith@company.com"|"www.shadyacresbrokerage.com"|"303-555-1234"|""|"303-555-1235"|"303-555-1236"|"1234_photo.jpg"|"123 Main Street"|""|"Shady Acres"|"CO"|"12345"|"www.shadyacresbrokerage.com"|"124 Main Street"|"5"|"Shady Acres"|"CO"|"12345"|"sab_logo.gif"|""|""|"2009-07-13 11:25:23"|"0"|"1"|"0"|""|"0"|""|""
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]

Resource Definitions:Agents

WikiSysop — Tue, 22 Nov 2011 20:37:15 GMT

WikiSysop: /* GET */

The ''agents'' resource is a collection of all agent accounts associated with your company.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/agents</nowiki>

Available methods are:

== GET ==
Returns a list of agents. Each agent record includes the following fields:

* user_id
* user_email
* user_status_id - ''possible values: 1 (active), 2 (suspended), 3 (trial), 4 (pending), 5 (free), 6 (deactivated)''
* user_fname
* user_lname
* user_company_name
* user_email_work
* user_website
* user_phone_work
* user_phone_home
* user_phone_mobile
* user_phone_fax
* user_photo_path
* user_home_street
* user_home_suite
* user_home_city
* user_home_state
* user_home_zip
* user_company_website
* user_company_street
* user_company_suite
* user_company_city
* user_company_state
* user_company_zip
* user_company_logo_path
* user_tagline
* user_bio
* user_date
* user_report_daily - ''possible values: 0, 1 (receives daily status email)''
* user_report_weekly - ''possible values: 0, 1 (receives weekly status email)''
* user_report_monthly - ''possible values: 0, 1 (receives monthly status email)''
* user_sitename
* user_directory_hidden - ''possible values: 0, 1 (not displayed on agent directory page)''
* brokerage_employee_id
* key_username

=== Example Response - XML ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<agents version="1.0">
<agent>
<user_id>1234</user_id>
<user_email>john.smith@company.com</user_email>
<user_status_id>1</user_status_id>
<user_fname>John</user_fname>
<user_lname>Smith</user_lname>
<user_company_name>Shady Acres Brokerage</user_company_name>
<user_email_work>john.smith@company.com</user_email_work>
<user_website>www.shadyacresbrokerage.com</user_website>
<user_phone_work>303-555-1234</user_phone_work>
<user_phone_home></user_phone_home>
<user_phone_mobile>303-555-1235</user_phone_mobile>
<user_phone_fax>303-555-1236</user_phone_fax>
<user_photo_path>1234_photo.jpg</user_photo_path>
<user_home_street>123 Main Street</user_home_street>
<user_home_suite></user_home_suite>
<user_home_city>Shady Acres</user_home_city>
<user_home_state>CO</user_home_state>
<user_home_zip>12345</user_home_zip>
<user_company_website>www.shadyacresbrokerage.com</user_company_website>
<user_company_street>124 Main Street</user_company_street>
<user_company_suite>5</user_company_suite>
<user_company_city>Shady Acres</user_company_city>
<user_company_state>CO</user_company_state>
<user_company_zip>12345</user_company_zip>
<user_company_logo_path>sab_logo.gif</user_company_logo_path>
<user_tagline></user_tagline>
<user_bio></user_bio>
<user_date>2009-07-13 11:25:23</user_date>
<user_report_daily>0</user_report_daily>
<user_report_weekly>1</user_report_weekly>
<user_report_monthly>0</user_report_monthly>
<user_sitename></user_sitename>
<user_directory_hidden>0</user_directory_hidden>
<brokerage_employee_id></brokerage_employee_id>
<key_username></key_username>
</agent>
...
</agents>
</source>

=== Example Response - JSON ===
<source lang="javascript">
[
{
"user_id":"1234",
"user_email":"john.smith@company.com",
"user_status_id":"1",
"user_fname":"John",
"user_lname":"Smith",
"user_company_name":"hady Acres Brokerage",
"user_email_work":"john.smith@company.com",
"user_website":"www.shadyacresbrokerage.com",
"user_phone_work":"303-555-1234",
"user_phone_home":"",
"user_phone_mobile":"303-555-1235",
"user_phone_fax":"303-555-1236",
"user_photo_path":"1234_photo.jpg",
"user_home_street":"123 Main Street",
"user_home_suite":"",
"user_home_city":"Shady Acres",
"user_home_state":"CO",
"user_home_zip":"12345",
"user_company_website":"www.shadyacresbrokerage.com",
"user_company_street":"124 Main Street",
"user_company_suite":"5",
"user_company_city":"Shady Acres",
"user_company_state":"CO",
"user_company_zip":"12345",
"user_company_logo_path":"sab_logo.gif",
"user_tagline":"",
"user_bio":"",
"user_date":"2009-07-13 11:25:23",
"user_report_daily":"0",
"user_report_weekly":"1",
"user_report_monthly":"0",
"user_sitename":"",
"user_directory_hidden":"0",
"brokerage_employee_id":"",
"key_username":""
},
...
]
</source>

=== Example Response - CSV ===
<div style="overflow: auto;">
<source lang="text">
"user_id"|"user_email"|"user_status_id"|"user_fname"|"user_lname"|"user_company_name"|"user_email_work"|"user_website"|"user_phone_work"|"user_phone_home"|"user_phone_mobile"|"user_phone_fax"|"user_photo_path"|"user_home_street"|"user_home_suite"|"user_home_city"|"user_home_state"|"user_home_zip"|"user_company_website"|"user_company_street"|"user_company_suite"|"user_company_city"|"user_company_state"|"user_company_zip"|"user_company_logo_path"|"user_tagline"|"user_bio"|"user_date"|"user_report_daily"|"user_report_weekly"|"user_report_monthly"|"user_sitename"|"user_directory_hidden"|"brokerage_employee_id"|"key_username"
"1234"|"john.smith@company.com"|"1"|"John"|"Smith"|"Shady Acres Brokerage"|"john.smith@company.com"|"www.shadyacresbrokerage.com"|"303-555-1234"|""|"303-555-1235"|"303-555-1236"|"1234_photo.jpg"|"123 Main Street"|""|"Shady Acres"|"CO"|"12345"|"www.shadyacresbrokerage.com"|"124 Main Street"|"5"|"Shady Acres"|"CO"|"12345"|"sab_logo.gif"|""|""|"2009-07-13 11:25:23"|"0"|"1"|"0"|""|"0"|""|""
...
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]

Code Examples

WikiSysop — Fri, 10 Sep 2010 15:10:15 GMT

WikiSysop:

Below are examples of how to access the API using PHP. These examples demonstrate a variety of available methods and content formats. While we do not cover every possible use of the API here, these examples meant to be indicative of all API calls.

All examples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any means that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.

== Example 1: read the ''agents'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be reading data from the agents collection
// resource. We'll retrieve the data in CSV format.
$strResourcePath = 'agents';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'text/csv';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 2: read the ''agents/ID'' resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be reading data from the resource for
// an agent with the ID 1234. We'll retrieve the data in XML format.
// Notice that the presence of the .xml extension will override the
// Accept header value ($strResponseFormat). Alternatively, you
// could leave off the extension and set the Accept header value
// ($strResponseFormat) to application/xml.
$strResourcePath = 'agents/1234.xml';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'text/csv';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 3: add a new contact to the ''contacts'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be posting data to the contacts collection
// resource to create a new contact. We'll send data in JSON format,
// and retrieve data in XML format.
$strResourcePath = 'contacts';
$strRequestFormat = 'application/json';
$strResponseFormat = 'application/xml';
$strData = '{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a POST request
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 4: update an individual contact from the ''contacts/ID'' resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be updating data for an existing contact resource.
// We'll send data in XML format, and retrieve data in CSV format.
$strResourcePath = 'contacts/123456';
$strRequestFormat = 'application/xml';
$strResponseFormat = 'text/csv';
$strData = '<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith-Johnson</contact_name>
<contact_email>jane.smith.johnson@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// PUT is originally intended for uploading files,
// so we have to make our data look like a file.
// Open a file resource using the php://memory stream
$fh = fopen('php://memory', 'rw');

// Write the data to the file
fwrite($fh, $strData);

// Move back to the beginning of the file
rewind($fh);

// Make this a PUT request
curl_setopt($ch, CURLOPT_PUT, true);
curl_setopt($ch, CURLOPT_INFILE, $fh);
curl_setopt($ch, CURLOPT_INFILESIZE, strlen($strData));

// Make the request and output the response.
echo curl_exec($ch);

// Close the file resource
fclose($fh);

// Close the cURL resource
curl_close($ch);
?>
</source>

== Example 5: delete all contacts from the ''contacts'' collection resource ==
<source lang="php">
<?php
// Set some universal configuration variables. These will be
// the same for all your API requests for a particular account.
$strUsername = 'YOUR_API_USERNAME';
$strPassword = 'YOUR_API_PASSWORD';
$strBaseURI = 'http://api.rezora.com/v1/';

// Set some configuration variables specific to the task at hand.
// In this example, we'll be deleting data from the contacts collection
// resource. We'll retrieve the data in JSON format.
$strResourcePath = 'contacts';
$strRequestFormat = 'text/plain';
$strResponseFormat = 'application/json';

// Open a cURL resource
$ch = curl_init();

// Set the necessary parameters
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword);
curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath);
curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Make this a DELETE request
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');

// Make the request and output the response.
echo curl_exec($ch);

// Close the cURL resource
curl_close($ch);
?>
</source>

Common Behaviors

WikiSysop — Fri, 10 Sep 2010 15:09:11 GMT

WikiSysop: /* Access Permissions */

Resource Definitions:Groups/ID/Agents/ID

WikiSysop — Tue, 03 Aug 2010 04:59:26 GMT

WikiSysop: Created page with 'The ''groups/ID/agents/ID'' resource is an individual agent-to-group association between the designated group and agent, where the first "ID" is the groups's group_id number and …'

The ''groups/ID/agents/ID'' resource is an individual agent-to-group association between the designated group and agent, where the first "ID" is the groups's group_id number and the second "ID" is the agent's agent_id number.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/groups/123/agents/12345</nowiki>

Available methods are:

== GET ==
Returns an individual agent-to-group association between the designated group and agent. The association record includes the following fields:

* usertogroup_id
* user_id
* group_id
* usertogroup_timestamp

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<group_agents version="1.0">
<group_agent>
<usertogroup_id>123456</usertogroup_id>
<user_id>12345</user_id>
<group_id>123</group_id>
<usertogroup_timestamp>2010-07-21 16:46:01</usertogroup_timestamp>
</group_agent>
</group_agents>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"usertogroup_id":"123456",
"user_id":"12345",
"group_id":"123",
"usertogroup_timestamp":"2010-07-21 16:46:01"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"usertogroup_id"|"user_id"|"group_id"|"usertogroup_timestamp"
"123456"|"12345"|"123"|"2010-07-21 16:46:01"
</source>
</div>

== DELETE ==
Permanently removes an individual agent-to-group association between the designated group and agent, and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<group_agents version="1.0">
<group_agent>
<status>200</status>
</group_agent>
</group_agents>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]

Resource Definitions

WikiSysop — Tue, 03 Aug 2010 04:59:17 GMT

WikiSysop:

This section defines the resources made available through the API. These include descriptions of the resource, a list of the methods supported, a list of the the data fields contained in the resource, and sample request and response data, where appropriate. The resources below are grouped into two sets, based on the type of user allowed to access them. The available resources are:

== Company Resources ==
* [[Resource_Definitions:Agents|Agents]]
* [[Resource_Definitions:Agents/ID|Agents/ID]]
* [[Resource_Definitions:Groups|Groups]]
* [[Resource_Definitions:Groups/ID|Groups/ID]]
* [[Resource_Definitions:Groups/ID/Agents|Groups/ID/Agents]]
* [[Resource_Definitions:Groups/ID/Agents/ID|Groups/ID/Agents/ID]]

== Agent Resources ==
* [[Resource_Definitions:Contacts|Contacts]]
* [[Resource_Definitions:Contacts/ID|Contacts/ID]]
* [[Resource_Definitions:Lists|Lists]]
* [[Resource_Definitions:Lists/ID|Lists/ID]]
* [[Resource_Definitions:Lists/ID/Contacts|Lists/ID/Contacts]]
* [[Resource_Definitions:Lists/ID/Contacts/ID|Lists/ID/Contacts/ID]]

Resource Definitions:Groups/ID/Agents

WikiSysop — Tue, 03 Aug 2010 04:54:06 GMT

WikiSysop: Created page with 'The ''groups/ID/agents'' resource is a collection of all agent-to-group associations for the designated group, where "ID" is the group's group_id number. '''''Example URI:'''''…'

The ''groups/ID/agents'' resource is a collection of all agent-to-group associations for the designated group, where "ID" is the group's group_id number.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/groups/123/agents</nowiki>

Available methods are:

== GET ==
Returns a list of agent-to-group associations for the designated group. Each association record includes the following fields:

* usertogroup_id
* user_id
* group_id
* usertogroup_timestamp

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<group_agents version="1.0">
<group_agent>
<usertogroup_id>1234567</usertogroup_id>
<user_id>12345</user_id>
<group_id>123</group_id>
<usertogroup_timestamp>2010-07-21 16:46:01</usertogroup_timestamp>
</group_agent>
...
</group_agents>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"usertogroup_id":"123456",
"user_id":"12345",
"group_id":"123",
"usertogroup_timestamp":"2010-07-21 16:46:01"
}
...
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"usertogroup_id"|"user_id"|"group_id"|"usertogroup_timestamp"
"123456"|"12345"|"123"|"2010-07-21 16:46:01"
...
</source>
</div>

== POST ==
Adds a new agent-to-group association for the designated group, and returns the new association ID. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* user_id '''<span style="color: #f00;">*</span>''' - ''must be unique within this group''

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<user_id>12346</user_id>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"user_id":"12346"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
user_id=12346
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<group_agents version="1.0">
<group_agent>
<usertogroup_id>123457</usertogroup_id>
</group_agent>
</group_agents>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"usertogroup_id":"123457"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"usertogroup_id"
"123457"
</source>
</div>

== DELETE ==
Permanently removes ALL agent-to-group associations for the designated group, and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<group_agents version="1.0">
<group_agent>
<status>200</status>
</group_agent>
</group_agents>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]

Resource Definitions

WikiSysop — Tue, 03 Aug 2010 04:53:57 GMT

WikiSysop:

This section defines the resources made available through the API. These include descriptions of the resource, a list of the methods supported, a list of the the data fields contained in the resource, and sample request and response data, where appropriate. The resources below are grouped into two sets, based on the type of user allowed to access them. The available resources are:

== Company Resources ==
* [[Resource_Definitions:Agents|Agents]]
* [[Resource_Definitions:Agents/ID|Agents/ID]]
* [[Resource_Definitions:Groups|Groups]]
* [[Resource_Definitions:Groups/ID|Groups/ID]]
* [[Resource_Definitions:Groups/ID/Agents|Groups/ID/Agents]]

== Agent Resources ==
* [[Resource_Definitions:Contacts|Contacts]]
* [[Resource_Definitions:Contacts/ID|Contacts/ID]]
* [[Resource_Definitions:Lists|Lists]]
* [[Resource_Definitions:Lists/ID|Lists/ID]]
* [[Resource_Definitions:Lists/ID/Contacts|Lists/ID/Contacts]]
* [[Resource_Definitions:Lists/ID/Contacts/ID|Lists/ID/Contacts/ID]]

Resource Definitions:Groups/ID

WikiSysop — Tue, 03 Aug 2010 04:43:01 GMT

WikiSysop: Created page with 'The ''groups/ID'' resource is an individual group associated with your company account, where "ID" is the group's group_id number. '''''Example URI:''''' <nowiki>http://api.rez…'

The ''groups/ID'' resource is an individual group associated with your company account, where "ID" is the group's group_id number.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/groups/123</nowiki>

Available methods are:

== GET ==
Returns an individual group. The group record includes the following fields:

* group_id
* group_name
* group_timestamp

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
<group>
<group_id>123</group_id>
<group_name>East Branch Office</group_name>
<group_timestamp>2010-07-21 16:28:52</group_timestamp>
</group>
</groups>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"group_id":"123",
"group_name":"East Branch Office",
"group_timestamp":"2010-07-21 16:28:52",
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"group_id"|"group_name"|"group_timestamp"
"123"|"East Branch Office"|"2010-07-21 16:28:52"
</source>
</div>

== PUT ==
Updates an existing group, and returns a success code. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* group_name '''<span style="color: #f00;">*</span>''' ''(must be unique)''

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<group_name>Eastern Branch Office</group_name>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"group_name":"Eastern Branch Office"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
group_name=Eastern+Branch+Office
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
<group>
<status>200</status>
</group>
</groups>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>

== DELETE ==
Permanently removes an individual group, and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
<group>
<status>200</status>
</group>
</groups>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]

Resource Definitions

WikiSysop — Tue, 03 Aug 2010 04:42:52 GMT

WikiSysop:

This section defines the resources made available through the API. These include descriptions of the resource, a list of the methods supported, a list of the the data fields contained in the resource, and sample request and response data, where appropriate. The resources below are grouped into two sets, based on the type of user allowed to access them. The available resources are:

== Company Resources ==
* [[Resource_Definitions:Agents|Agents]]
* [[Resource_Definitions:Agents/ID|Agents/ID]]
* [[Resource_Definitions:Groups|Groups]]
* [[Resource_Definitions:Groups/ID|Groups/ID]]

== Agent Resources ==
* [[Resource_Definitions:Contacts|Contacts]]
* [[Resource_Definitions:Contacts/ID|Contacts/ID]]
* [[Resource_Definitions:Lists|Lists]]
* [[Resource_Definitions:Lists/ID|Lists/ID]]
* [[Resource_Definitions:Lists/ID/Contacts|Lists/ID/Contacts]]
* [[Resource_Definitions:Lists/ID/Contacts/ID|Lists/ID/Contacts/ID]]

Resource Definitions:Lists/ID

WikiSysop — Tue, 03 Aug 2010 04:36:02 GMT

WikiSysop:

The ''lists/ID'' resource is an individual distribution list associated with your agent account, where "ID" is the list's list_id number.

Each agent account has one special list, known as the Primary Sphere. This list has a list_type value of 1, while all other lists have a list_type value of 0. The Primary Sphere cannot be updated or deleted. The delete all functionality deletes all lists with a list_type value of 0, but leaves the Primary Sphere in tact.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/lists/1234</nowiki>

Available methods are:

== GET ==
Returns an individual distribution list. The distribution list record includes the following fields:

* list_id
* list_name
* list_date
* list_type - ''possible values: 0, 1 (cannnot delete)''

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<lists version="1.0">
<list>
<list_id>1234</list_id>
<list_name>Current Prospects</list_name>
<list_date>2010-07-21 16:28:52</list_date>
<list_type>0</list_type>
</list>
</lists>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"list_id":"1234",
"list_name":"Current Prospects",
"list_date":"2010-07-21 16:28:52",
"list_type":"0"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"list_id"|"list_name"|"list_date"|"list_type"
"1234"|"Current Prospects"|"2010-07-21 16:28:52"|"0"
</source>
</div>

== PUT ==
Updates an existing distribution list, and returns a success code. Note the you CANNOT update a Primary Sphere list (list_type = 1). You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* list_name '''<span style="color: #f00;">*</span>''' ''(must be unique)''

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<list_name>Hot Leads</list_name>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"list_name":"Hot Leads"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
list_name=Hot+Leads
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<lists version="1.0">
<list>
<status>200</status>
</list>
</lists>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>

== DELETE ==
Permanently removes an individual distribution list, and returns a success code. Note the you CANNOT delete a Primary Sphere list (list_type = 1).

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<lists version="1.0">
<list>
<status>200</status>
</list>
</lists>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Groups

WikiSysop — Tue, 03 Aug 2010 04:33:40 GMT

WikiSysop: Created page with 'The ''groups'' resource is a collection of all groups associated with your company account. '''''Example URI:''''' <nowiki>http://api.rezora.com/v1/groups</nowiki> Available m…'

The ''groups'' resource is a collection of all groups associated with your company account.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/groups</nowiki>

Available methods are:

== GET ==
Returns a list of groups. Each group record includes the following fields:

* group_id
* group_name
* group_timestamp

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
<group>
<group_id>123</group_id>
<group_name>East Branch Office</group_name>
<group_timestamp>2010-07-21 16:28:52</group_timestamp>
</group>
...
</groups>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"group_id":"123",
"group_name":"East Branch Office",
"group_timestamp":"2010-07-21 16:28:52"
}
...
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"group_id"|"group_name"|"group_timestamp"
"123"|"East Branch Office"|"2010-07-21 16:28:52"
...
</source>
</div>

== POST ==
Adds a new group, and returns the new group ID. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* group_name '''<span style="color: #f00;">*</span>''' - ''must be unique''

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<group_name>West Branch Office</group_name>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"group_name":"West Branch Office"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
group_name=West+Branch+Office
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
<group>
<group_id>124</group_id>
</group>
</groups>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"group_id":"124"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"group_id"
"124"
</source>
</div>

== DELETE ==
Permanently removes ALL groups and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
<group>
<status>200</status>
</group>
</groups>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]

Resource Definitions

WikiSysop — Tue, 03 Aug 2010 04:33:16 GMT

WikiSysop:

This section defines the resources made available through the API. These include descriptions of the resource, a list of the methods supported, a list of the the data fields contained in the resource, and sample request and response data, where appropriate. The resources below are grouped into two sets, based on the type of user allowed to access them. The available resources are:

== Company Resources ==
* [[Resource_Definitions:Agents|Agents]]
* [[Resource_Definitions:Agents/ID|Agents/ID]]
* [[Resource_Definitions:Groups|Groups]]

== Agent Resources ==
* [[Resource_Definitions:Contacts|Contacts]]
* [[Resource_Definitions:Contacts/ID|Contacts/ID]]
* [[Resource_Definitions:Lists|Lists]]
* [[Resource_Definitions:Lists/ID|Lists/ID]]
* [[Resource_Definitions:Lists/ID/Contacts|Lists/ID/Contacts]]
* [[Resource_Definitions:Lists/ID/Contacts/ID|Lists/ID/Contacts/ID]]

Category:Agent Resources

WikiSysop — Fri, 23 Jul 2010 15:17:02 GMT

WikiSysop: Created page with 'Agent resources are accessible only with agent-level credentials. Agent resources provide data and functionality that are specific to agent-level accounts on the Rezora system.'

Agent resources are accessible only with agent-level credentials. Agent resources provide data and functionality that are specific to agent-level accounts on the Rezora system.

Category:Resource Definitions

WikiSysop — Fri, 23 Jul 2010 15:16:13 GMT

WikiSysop:

This section defines all resources made available through the Rezora REST API. These include descriptions of the resource, a list of the methods supported, a list of the the data fields returned, and sample request response data, where appropriate.

Resource Definitions:Lists/ID/Contacts/ID

WikiSysop — Fri, 23 Jul 2010 15:14:25 GMT

WikiSysop:

The ''lists/ID/contacts/ID'' resource is an individual contact-to-list association between the designated distribution list and contact, where the first "ID" is the list's list_id number and the second "ID" is the contact's contact_id number.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/lists/1234/contacts/123456</nowiki>

Available methods are:

== GET ==
Returns an individual contact-to-list association between the designated distribution list and contact. The association record includes the following fields:

* contacttolist_id
* contact_id
* list_id
* contacttolist_date

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<list_contacts version="1.0">
<list_contact>
<contacttolist_id>1234567</contacttolist_id>
<contact_id>123456</contact_id>
<list_id>1234</list_id>
<contacttolist_date>2010-07-21 16:46:01</contacttolist_date>
</list_contact>
</list_contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contacttolist_id":"1234567",
"contact_id":"123456",
"list_id":"1234",
"contacttolist_date":"2010-07-21 16:46:01"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contacttolist_id"|"contact_id"|"list_id"|"contacttolist_date"
"1234567"|"123456"|"1234"|"2010-07-21 16:46:01"
</source>
</div>

== DELETE ==
Permanently removes an individual contact-to-list association between the designated distribution list and contact, and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<list_contacts version="1.0">
<list_contact>
<status>200</status>
</list_contact>
</list_contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Lists/ID/Contacts

WikiSysop — Fri, 23 Jul 2010 15:14:12 GMT

WikiSysop:

The ''lists/ID/contacts'' resource is a collection of all contact-to-list associations for the designated distribution list, where "ID" is the list's list_id number.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/lists/1234/contacts</nowiki>

Available methods are:

== GET ==
Returns a list of contact-to-list associations for the designated distribution list. Each association record includes the following fields:

* contacttolist_id
* contact_id
* list_id
* contacttolist_date

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<list_contacts version="1.0">
<list_contact>
<contacttolist_id>1234567</contacttolist_id>
<contact_id>123456</contact_id>
<list_id>1234</list_id>
<contacttolist_date>2010-07-21 16:46:01</contacttolist_date>
</list_contact>
...
</list_contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contacttolist_id":"1234567",
"contact_id":"123456",
"list_id":"1234",
"contacttolist_date":"2010-07-21 16:46:01"
}
...
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contacttolist_id"|"contact_id"|"list_id"|"contacttolist_date"
"1234567"|"123456"|"1234"|"2010-07-21 16:46:01"
...
</source>
</div>

== POST ==
Adds a new contact-to-list association for the designated distribution list, and returns the new association ID. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* contact_id '''<span style="color: #f00;">*</span>''' - ''must be unique within this distribution list''

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_id>123457</contact_id>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"contact_id":"123457"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
contact_id=123457
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<list_contacts version="1.0">
<list_contact>
<contacttolist_id>1234568</contacttolist_id>
</list_contact>
</list_contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contacttolist_id":"1234568"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contacttolist_id"
"1234568"
</source>
</div>

== DELETE ==
Permanently removes ALL contact-to-list associations for the designated distribution list, and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<list_contacts version="1.0">
<list_contact>
<status>200</status>
</list_contact>
</list_contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Lists/ID

WikiSysop — Fri, 23 Jul 2010 15:13:58 GMT

WikiSysop:

The ''lists/ID'' resource is an individual distribution list associated with your agent account, where "ID" is the list's list_id number.

Each agent account has one special list, known as the Primary Sphere. This list has a list_type value of 1, while all other lists have a list_type value of 0. The Primary Sphere cannot be updated or deleted. The delete all functionality deletes all lists with a list_type value of 0, but leaves the Primary Sphere in tact.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/lists/1234</nowiki>

Available methods are:

== GET ==
Returns an individual distribution. The distribution list record includes the following fields:

* list_id
* list_name
* list_date
* list_type - ''possible values: 0, 1 (cannnot delete)''

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<lists version="1.0">
<list>
<list_id>1234</list_id>
<list_name>Current Prospects</list_name>
<list_date>2010-07-21 16:28:52</list_date>
<list_type>0</list_type>
</list>
</lists>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"list_id":"1234",
"list_name":"Current Prospects",
"list_date":"2010-07-21 16:28:52",
"list_type":"0"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"list_id"|"list_name"|"list_date"|"list_type"
"1234"|"Current Prospects"|"2010-07-21 16:28:52"|"0"
</source>
</div>

== PUT ==
Updates an existing distribution list, and returns a success code. Note the you CANNOT update a Primary Sphere list (list_type = 1). You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* list_name '''<span style="color: #f00;">*</span>''' ''(must be unique)''

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<list_name>Hot Leads</list_name>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"list_name":"Hot Leads"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
list_name=Hot+Leads
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<lists version="1.0">
<list>
<status>200</status>
</list>
</lists>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>

== DELETE ==
Permanently removes an individual distribution list, and returns a success code. Note the you CANNOT delete a Primary Sphere list (list_type = 1).

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<lists version="1.0">
<list>
<status>200</status>
</list>
</lists>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Lists

WikiSysop — Fri, 23 Jul 2010 15:13:44 GMT

WikiSysop:

The ''lists'' resource is a collection of all distribution lists associated with your agent account.

Each agent account has one special list, known as the Primary Sphere. This list has a list_type value of 1, while all other lists have a list_type value of 0. The Primary Sphere cannot be updated or deleted. The delete all functionality deletes all lists with a list_type value of 0, but leaves the Primary Sphere in tact.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/lists</nowiki>

Available methods are:

== GET ==
Returns a list of distribution lists. Each list record includes the following fields:

* list_id
* list_name
* list_date
* list_type - ''possible values: 0, 1 (cannot update or delete)''

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<lists version="1.0">
<list>
<list_id>1234</list_id>
<list_name>Current Prospects</list_name>
<list_date>2010-07-21 16:28:52</list_date>
<list_type>0</list_type>
</list>
...
</lists>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"list_id":"1234",
"list_name":"Current Prospects",
"list_date":"2010-07-21 16:28:52",
"list_type":"0"
}
...
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"list_id"|"list_name"|"list_date"|"list_type"
"1234"|"Current Prospects"|"2010-07-21 16:28:52"|"0"
...
</source>
</div>

== POST ==
Adds a new list, and returns the new list ID. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* list_name '''<span style="color: #f00;">*</span>''' - ''must be unique''

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<list_name>New Leads</list_name>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"list_name":"New Leads"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
list_name=New+Leads
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<lists version="1.0">
<list>
<list_id>1235</list_id>
</list>
</lists>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"list_id":"1235"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"list_id"
"1235"
</source>
</div>

== DELETE ==
Permanently removes ALL distribution lists (except for the Primary Sphere), and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<lists version="1.0">
<list>
<status>200</status>
</list>
</lists>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Contacts/ID

WikiSysop — Fri, 23 Jul 2010 15:13:26 GMT

WikiSysop:

The ''contacts/ID'' resource is an individual contact entry associated with your agent account, where "ID" is the contact's contact_id number.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/contacts/123456</nowiki>

Available methods are:

== GET ==
Returns an individual contact. The contact record includes the following fields:

* contact_id
* contact_name
* contact_email
* contact_type - ''possible values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip
* contact_date
* contact_self - ''possible values: 0, 1 (cannot delete)''

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<contact_id>123456</contact_id>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
<contact_date>2010-07-16 22:34:01</contact_date>
<contact_self>0</contact_self>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contact_id":"123456",
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345",
"contact_date":"2010-07-16 22:34:01",
"contact_self":"0"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contact_id"|"contact_name"|"contact_email"|"contact_type"|"contact_title"|"contact_company"|"contact_phone_home"|"contact_phone_work"|"contact_phone_mobile"|"contact_phone_fax"|"contact_business_street"|"contact_business_street2"|"contact_business_city"|"contact_business_state"|"contact_business_zip"|"contact_home_street"|"contact_home_street2"|"contact_home_city"|"contact_home_state"|"contact_home_zip"|"contact_date"|"contact_self"
"123456"|"Jane Smith"|"jane.smith@company.com"|"Active"|"Consultant"|"Acme Consulting"|"303-555-1234"|"303-555-1235"|"303-555-1236"|"303-555-1237"|"123 Church Street"|"Suite 12"|"Shady Acres"|"CO"|"12345"|"124 Church Street"|""|"Shady Acres"|"CO"|"12345"|"2010-07-16 22:34:01"|"0"
</source>
</div>

== PUT ==
Updates an existing contact, and returns a success code. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* contact_name
* contact_email '''<span style="color: #f00;">*</span>''' - ''must be a valid email address, must be unique''
* contact_type - ''possible values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
contact_name=Jane+Smith&contact_email=jane.smith%40company.com&contact_type=Active&contact_title=Consultant&contact_company=Acme+Consulting&contact_phone_home=303-555-1234&contact_phone_work=303-555-1235&contact_phone_mobile=303-555-1236&contact_phone_fax=303-555-1237&contact_business_street=123+Church+Street&contact_business_street2=Suite+12&contact_business_city=Shady+Acres&contact_business_state=CO&contact_business_zip=12345&contact_home_street=124+Church+Street&contact_home_street2=&contact_home_city=Shady+Acres&contact_home_state=CO&contact_home_zip=12345
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<status>200</status>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>

== DELETE ==
Permanently removes an individual contact, and returns a success code. Note the you CANNOT delete the self contact (contact_self = 1).

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<status>200</status>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Contacts

WikiSysop — Fri, 23 Jul 2010 15:13:03 GMT

WikiSysop:

The ''contacts'' resource is a collection of all contacts associated with your agent account.

Each agent account has one special contact, known as the "self contact." This contact has a contact_self value of 1, while all other contacts have a contact_self value of 0. The self contact cannot be deleted. The delete all functionality deletes all contacts with a contact_self value of 0, but leaves the self contact in tact.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/contacts</nowiki>

Available methods are:

== GET ==
Returns a list of contacts. Each contact record includes the following fields:

* contact_id
* contact_name
* contact_email
* contact_type - ''possible values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip
* contact_date
* contact_self - ''possible values: 0, 1 (cannot delete)''

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<contact_id>123456</contact_id>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
<contact_date>2010-07-16 22:34:01</contact_date>
<contact_self>0</contact_self>
</contact>
...
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contact_id":"123456",
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345",
"contact_date":"2010-07-16 22:34:01",
"contact_self":"0"
}
...
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contact_id"|"contact_name"|"contact_email"|"contact_type"|"contact_title"|"contact_company"|"contact_phone_home"|"contact_phone_work"|"contact_phone_mobile"|"contact_phone_fax"|"contact_business_street"|"contact_business_street2"|"contact_business_city"|"contact_business_state"|"contact_business_zip"|"contact_home_street"|"contact_home_street2"|"contact_home_city"|"contact_home_state"|"contact_home_zip"|"contact_date"|"contact_self"
"123456"|"Jane Smith"|"jane.smith@company.com"|"Active"|"Consultant"|"Acme Consulting"|"303-555-1234"|"303-555-1235"|"303-555-1236"|"303-555-1237"|"123 Church Street"|"Suite 12"|"Shady Acres"|"CO"|"12345"|"124 Church Street"|""|"Shady Acres"|"CO"|"12345"|"2010-07-16 22:34:01"|"0"
...
</source>
</div>

== POST ==
Adds a new contact, and returns the new contact ID. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* contact_name
* contact_email '''<span style="color: #f00;">*</span>''' - ''must be a valid email address, must be unique''
* contact_type - ''accepted values: Hot, Active, Inactive, empty string (indicates no type)''
* contact_title
* contact_company
* contact_phone_home
* contact_phone_work
* contact_phone_mobile
* contact_phone_fax
* contact_business_street
* contact_business_street2
* contact_business_city
* contact_business_state
* contact_business_zip
* contact_home_street
* contact_home_street2
* contact_home_city
* contact_home_state
* contact_home_zip

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<contact_name>Jane Smith</contact_name>
<contact_email>jane.smith@company.com</contact_email>
<contact_type>Active</contact_type>
<contact_title>Consultant</contact_title>
<contact_company>Acme Consulting</contact_company>
<contact_phone_home>303-555-1234</contact_phone_home>
<contact_phone_work>303-555-1235</contact_phone_work>
<contact_phone_mobile>303-555-1236</contact_phone_mobile>
<contact_phone_fax>303-555-1237</contact_phone_fax>
<contact_business_street>123 Church Street</contact_business_street>
<contact_business_street2>Suite 12</contact_business_street2>
<contact_business_city>Shady Acres</contact_business_city>
<contact_business_state>CO</contact_business_state>
<contact_business_zip>12345</contact_business_zip>
<contact_home_street>124 Church Street</contact_home_street>
<contact_home_street2></contact_home_street2>
<contact_home_city>Shady Acres</contact_home_city>
<contact_home_state>CO</contact_home_state>
<contact_home_zip>12345</contact_home_zip>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"contact_name":"Jane Smith",
"contact_email":"jane.smith@company.com",
"contact_type":"Active",
"contact_title":"Consultant",
"contact_company":"Acme Consulting",
"contact_phone_home":"303-555-1234",
"contact_phone_work":"303-555-1235",
"contact_phone_mobile":"303-555-1236",
"contact_phone_fax":"303-555-1237",
"contact_business_street":"123 Church Street",
"contact_business_street2":"Suite 12",
"contact_business_city":"Shady Acres",
"contact_business_state":"CO",
"contact_business_zip":"12345",
"contact_home_street":"124 Church Street",
"contact_home_street2":"",
"contact_home_city":"Shady Acres",
"contact_home_state":"CO",
"contact_home_zip":"12345"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
contact_name=Jane+Smith&contact_email=jane.smith%40company.com&contact_type=Active&contact_title=Consultant&contact_company=Acme+Consulting&contact_phone_home=303-555-1234&contact_phone_work=303-555-1235&contact_phone_mobile=303-555-1236&contact_phone_fax=303-555-1237&contact_business_street=123+Church+Street&contact_business_street2=Suite+12&contact_business_city=Shady+Acres&contact_business_state=CO&contact_business_zip=12345&contact_home_street=124+Church+Street&contact_home_street2=&contact_home_city=Shady+Acres&contact_home_state=CO&contact_home_zip=12345
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<contact_id>123456</contact_id>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"contact_id":"123456"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"contact_id"
"123456"
</source>
</div>

== DELETE ==
Permanently removes ALL contacts (except for the self contact), and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
<contact>
<status>200</status>
</contact>
</contacts>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Agent Resources]]

Resource Definitions:Agents/ID

WikiSysop — Fri, 23 Jul 2010 15:11:29 GMT

WikiSysop:

The ''agents/ID'' resource references an individual agent account, where "ID" is the agent's user_id number.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/agents/1234</nowiki>

Available methods are:

== GET ==

Returns a list of account settings for the specified agent. The response includes the following fields:
* user_id
* user_email
* user_status_id - ''possible values: 1 (active), 2 (suspended), 3 (trial), 4 (pending), 5 (free), 6 (deactivated)''
* user_fname
* user_lname
* user_company_name
* user_email_work
* user_website
* user_phone_work
* user_phone_home
* user_phone_mobile
* user_phone_fax
* user_photo_path
* user_home_street
* user_home_suite
* user_home_city
* user_home_state
* user_home_zip
* user_company_website
* user_company_street
* user_company_suite
* user_company_city
* user_company_state
* user_company_zip
* user_company_logo_path
* user_tagline
* user_bio
* user_date
* user_report_daily - ''possible values: 0, 1 (receives daily status email)''
* user_report_weekly - ''possible values: 0, 1 (receives weekly status email)''
* user_report_monthly - ''possible values: 0, 1 (receives monthly status email)''
* user_sitename
* user_directory_hidden - ''possible values: 0, 1 (not displayed on agent directory page)''
* brokerage_employee_id

=== Example Response - XML ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<agents version="1.0">
<agent>
<user_id>1234</user_id>
<user_email>john.smith@company.com</user_email>
<user_status_id>1</user_status_id>
<user_fname>John</user_fname>
<user_lname>Smith</user_lname>
<user_company_name>Shady Acres Brokerage</user_company_name>
<user_email_work>john.smith@company.com</user_email_work>
<user_website>www.shadyacresbrokerage.com</user_website>
<user_phone_work>303-555-1234</user_phone_work>
<user_phone_home></user_phone_home>
<user_phone_mobile>303-555-1235</user_phone_mobile>
<user_phone_fax>303-555-1236</user_phone_fax>
<user_photo_path>1234_photo.jpg</user_photo_path>
<user_home_street>123 Main Street</user_home_street>
<user_home_suite></user_home_suite>
<user_home_city>Shady Acres</user_home_city>
<user_home_state>CO</user_home_state>
<user_home_zip>12345</user_home_zip>
<user_company_website>www.shadyacresbrokerage.com</user_company_website>
<user_company_street>124 Main Street</user_company_street>
<user_company_suite>5</user_company_suite>
<user_company_city>Shady Acres</user_company_city>
<user_company_state>CO</user_company_state>
<user_company_zip>12345</user_company_zip>
<user_company_logo_path>sab_logo.gif</user_company_logo_path>
<user_tagline></user_tagline>
<user_bio></user_bio>
<user_date>2009-07-13 11:25:23</user_date>
<user_report_daily>0</user_report_daily>
<user_report_weekly>1</user_report_weekly>
<user_report_monthly>0</user_report_monthly>
<user_sitename></user_sitename>
<user_directory_hidden>0</user_directory_hidden>
<brokerage_employee_id></brokerage_employee_id>
</agent>
</agents>
</source>

=== Example Response - JSON ===
<source lang="javascript">
[
{
"user_id":"1234",
"user_email":"john.smith@company.com",
"user_status_id":"1",
"user_fname":"John",
"user_lname":"Smith",
"user_company_name":"hady Acres Brokerage",
"user_email_work":"john.smith@company.com",
"user_website":"www.shadyacresbrokerage.com",
"user_phone_work":"303-555-1234",
"user_phone_home":"",
"user_phone_mobile":"303-555-1235",
"user_phone_fax":"303-555-1236",
"user_photo_path":"1234_photo.jpg",
"user_home_street":"123 Main Street",
"user_home_suite":"",
"user_home_city":"Shady Acres",
"user_home_state":"CO",
"user_home_zip":"12345",
"user_company_website":"www.shadyacresbrokerage.com",
"user_company_street":"124 Main Street",
"user_company_suite":"5",
"user_company_city":"Shady Acres",
"user_company_state":"CO",
"user_company_zip":"12345",
"user_company_logo_path":"sab_logo.gif",
"user_tagline":"",
"user_bio":"",
"user_date":"2009-07-13 11:25:23",
"user_report_daily":"0",
"user_report_weekly":"1",
"user_report_monthly":"0",
"user_sitename":"",
"user_directory_hidden":"0",
"brokerage_employee_id":""
}
]
</source>

=== Example Response - CSV ===
<div style="overflow: auto;">
<source lang="text">
"user_id"|"user_email"|"user_status_id"|"user_fname"|"user_lname"|"user_company_name"|"user_email_work"|"user_website"|"user_phone_work"|"user_phone_home"|"user_phone_mobile"|"user_phone_fax"|"user_photo_path"|"user_home_street"|"user_home_suite"|"user_home_city"|"user_home_state"|"user_home_zip"|"user_company_website"|"user_company_street"|"user_company_suite"|"user_company_city"|"user_company_state"|"user_company_zip"|"user_company_logo_path"|"user_tagline"|"user_bio"|"user_date"|"user_report_daily"|"user_report_weekly"|"user_report_monthly"|"user_sitename"|"user_directory_hidden"|"brokerage_employee_id"
"1234"|"john.smith@company.com"|"1"|"John"|"Smith"|"Shady Acres Brokerage"|"john.smith@company.com"|"www.shadyacresbrokerage.com"|"303-555-1234"|""|"303-555-1235"|"303-555-1236"|"1234_photo.jpg"|"123 Main Street"|""|"Shady Acres"|"CO"|"12345"|"www.shadyacresbrokerage.com"|"124 Main Street"|"5"|"Shady Acres"|"CO"|"12345"|"sab_logo.gif"|""|""|"2009-07-13 11:25:23"|"0"|"1"|"0"|""|"0"|""
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]

Category:Company Resources

WikiSysop — Fri, 23 Jul 2010 15:10:56 GMT

WikiSysop:

Company resources are accessible only with company-level credentials. Company resources provide data and functionality that are specific to company-level accounts on the Rezora system.

Category:Company Resources

WikiSysop — Fri, 23 Jul 2010 15:10:41 GMT

WikiSysop: Created page with '== Company Resources == Company resources are accessible only with company-level credentials. Company resources provide data and functionality that are specific to company-level…'

== Company Resources ==

Company resources are accessible only with company-level credentials. Company resources provide data and functionality that are specific to company-level accounts on the Rezora system.

Resource Definitions:Agents

WikiSysop — Fri, 23 Jul 2010 15:08:41 GMT

WikiSysop:

The ''agents'' resource is a collection of all agent accounts associated with your company.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/agents</nowiki>

Available methods are:

== GET ==
Returns a list of agents. Each agent record includes the following fields:

* user_id
* user_email
* user_status_id - ''possible values: 1 (active), 2 (suspended), 3 (trial), 4 (pending), 5 (free), 6 (deactivated)''
* user_fname
* user_lname
* user_company_name
* user_email_work
* user_website
* user_phone_work
* user_phone_home
* user_phone_mobile
* user_phone_fax
* user_photo_path
* user_home_street
* user_home_suite
* user_home_city
* user_home_state
* user_home_zip
* user_company_website
* user_company_street
* user_company_suite
* user_company_city
* user_company_state
* user_company_zip
* user_company_logo_path
* user_tagline
* user_bio
* user_date
* user_report_daily - ''possible values: 0, 1 (receives daily status email)''
* user_report_weekly - ''possible values: 0, 1 (receives weekly status email)''
* user_report_monthly - ''possible values: 0, 1 (receives monthly status email)''
* user_sitename
* user_directory_hidden - ''possible values: 0, 1 (not displayed on agent directory page)''
* brokerage_employee_id

=== Example Response - XML ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<agents version="1.0">
<agent>
<user_id>1234</user_id>
<user_email>john.smith@company.com</user_email>
<user_status_id>1</user_status_id>
<user_fname>John</user_fname>
<user_lname>Smith</user_lname>
<user_company_name>Shady Acres Brokerage</user_company_name>
<user_email_work>john.smith@company.com</user_email_work>
<user_website>www.shadyacresbrokerage.com</user_website>
<user_phone_work>303-555-1234</user_phone_work>
<user_phone_home></user_phone_home>
<user_phone_mobile>303-555-1235</user_phone_mobile>
<user_phone_fax>303-555-1236</user_phone_fax>
<user_photo_path>1234_photo.jpg</user_photo_path>
<user_home_street>123 Main Street</user_home_street>
<user_home_suite></user_home_suite>
<user_home_city>Shady Acres</user_home_city>
<user_home_state>CO</user_home_state>
<user_home_zip>12345</user_home_zip>
<user_company_website>www.shadyacresbrokerage.com</user_company_website>
<user_company_street>124 Main Street</user_company_street>
<user_company_suite>5</user_company_suite>
<user_company_city>Shady Acres</user_company_city>
<user_company_state>CO</user_company_state>
<user_company_zip>12345</user_company_zip>
<user_company_logo_path>sab_logo.gif</user_company_logo_path>
<user_tagline></user_tagline>
<user_bio></user_bio>
<user_date>2009-07-13 11:25:23</user_date>
<user_report_daily>0</user_report_daily>
<user_report_weekly>1</user_report_weekly>
<user_report_monthly>0</user_report_monthly>
<user_sitename></user_sitename>
<user_directory_hidden>0</user_directory_hidden>
<brokerage_employee_id></brokerage_employee_id>
</agent>
...
</agents>
</source>

=== Example Response - JSON ===
<source lang="javascript">
[
{
"user_id":"1234",
"user_email":"john.smith@company.com",
"user_status_id":"1",
"user_fname":"John",
"user_lname":"Smith",
"user_company_name":"hady Acres Brokerage",
"user_email_work":"john.smith@company.com",
"user_website":"www.shadyacresbrokerage.com",
"user_phone_work":"303-555-1234",
"user_phone_home":"",
"user_phone_mobile":"303-555-1235",
"user_phone_fax":"303-555-1236",
"user_photo_path":"1234_photo.jpg",
"user_home_street":"123 Main Street",
"user_home_suite":"",
"user_home_city":"Shady Acres",
"user_home_state":"CO",
"user_home_zip":"12345",
"user_company_website":"www.shadyacresbrokerage.com",
"user_company_street":"124 Main Street",
"user_company_suite":"5",
"user_company_city":"Shady Acres",
"user_company_state":"CO",
"user_company_zip":"12345",
"user_company_logo_path":"sab_logo.gif",
"user_tagline":"",
"user_bio":"",
"user_date":"2009-07-13 11:25:23",
"user_report_daily":"0",
"user_report_weekly":"1",
"user_report_monthly":"0",
"user_sitename":"",
"user_directory_hidden":"0",
"brokerage_employee_id":""
},
...
]
</source>

=== Example Response - CSV ===
<div style="overflow: auto;">
<source lang="text">
"user_id"|"user_email"|"user_status_id"|"user_fname"|"user_lname"|"user_company_name"|"user_email_work"|"user_website"|"user_phone_work"|"user_phone_home"|"user_phone_mobile"|"user_phone_fax"|"user_photo_path"|"user_home_street"|"user_home_suite"|"user_home_city"|"user_home_state"|"user_home_zip"|"user_company_website"|"user_company_street"|"user_company_suite"|"user_company_city"|"user_company_state"|"user_company_zip"|"user_company_logo_path"|"user_tagline"|"user_bio"|"user_date"|"user_report_daily"|"user_report_weekly"|"user_report_monthly"|"user_sitename"|"user_directory_hidden"|"brokerage_employee_id"
"1234"|"john.smith@company.com"|"1"|"John"|"Smith"|"Shady Acres Brokerage"|"john.smith@company.com"|"www.shadyacresbrokerage.com"|"303-555-1234"|""|"303-555-1235"|"303-555-1236"|"1234_photo.jpg"|"123 Main Street"|""|"Shady Acres"|"CO"|"12345"|"www.shadyacresbrokerage.com"|"124 Main Street"|"5"|"Shady Acres"|"CO"|"12345"|"sab_logo.gif"|""|""|"2009-07-13 11:25:23"|"0"|"1"|"0"|""|"0"|""
...
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]