Resource Definitions:Lists/ID/Contacts - Revision history

WikiSysop at 15:14, 23 July 2010

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

← Older revision		Revision as of 15:14, 23 July 2010
Line 144:		Line 144:
	</div>		</div>
	[[Category:Resource Definitions]]		[[Category:Resource Definitions]]
		+	[[Category:Agent Resources]]

WikiSysop at 13:54, 22 July 2010

WikiSysop — Thu, 22 Jul 2010 13:54:28 GMT

← Older revision		Revision as of 13:54, 22 July 2010
Line 1:		Line 1:
-	The lists/ID/contacts resource is a collection of all contact-to-list associations for the designated distribution list.	+	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>		'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/lists/1234/contacts</nowiki>

WikiSysop at 06:35, 22 July 2010

WikiSysop — Thu, 22 Jul 2010 06:35:21 GMT

← Older revision		Revision as of 06:35, 22 July 2010
Line 1:		Line 1:
	The lists/ID/contacts resource is a collection of all contact-to-list associations for the designated distribution list.		The lists/ID/contacts resource is a collection of all contact-to-list associations for the designated distribution list.

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

	Available methods are:		Available methods are:

WikiSysop: /* XML Response */

WikiSysop — Thu, 22 Jul 2010 06:33:58 GMT

XML Response

← Older revision		Revision as of 06:33, 22 July 2010
Line 26:		Line 26:
	<contacttolist_date>2010-07-21 16:46:01</contacttolist_date>		<contacttolist_date>2010-07-21 16:46:01</contacttolist_date>
	</list_contact>		</list_contact>
		+	...
	</list_contacts>		</list_contacts>
	</source>		</source>

WikiSysop: Created page with 'The lists/ID/contacts resource is a collection of all contact-to-list associations for the designated distribution list. '''''Example URI:''''' http://api.rezora.com/v1…'

WikiSysop — Thu, 22 Jul 2010 06:18:09 GMT

Created page with 'The lists/ID/contacts resource is a collection of all contact-to-list associations for the designated distribution list. '''''Example URI:''''' <nowiki>http://api.rezora.com/v1…'

New page

The lists/ID/contacts resource is a collection of all contact-to-list associations for the designated distribution list.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/lists/ID/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]]