Resource Definitions:Lists - Revision history

WikiSysop at 15:13, 23 July 2010

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

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

WikiSysop at 14:03, 22 July 2010

WikiSysop — Thu, 22 Jul 2010 14:03:31 GMT

← Older revision		Revision as of 14:03, 22 July 2010
Line 1:		Line 1:
	The ''lists'' resource is a collection of all distribution lists associated with your agent account.		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.	+	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>		'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/lists</nowiki>

WikiSysop at 13:52, 22 July 2010

WikiSysop — Thu, 22 Jul 2010 13:52:34 GMT

← Older revision		Revision as of 13:52, 22 July 2010
Line 1:		Line 1:
-	The lists resource is a collection of all distribution lists associated with your agent account.	+	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.		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.

WikiSysop: /* POST */

WikiSysop — Thu, 22 Jul 2010 05:44:20 GMT

POST

← Older revision		Revision as of 05:44, 22 July 2010
Line 56:		Line 56:
	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>''')):		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)''	+	* list_name '''<span style="color: #f00;">*</span>''' - ''must be unique''

	=== Example Request Data ===		=== Example Request Data ===

WikiSysop: /* GET */

WikiSysop — Thu, 22 Jul 2010 05:43:27 GMT

GET

← Older revision		Revision as of 05:43, 22 July 2010
Line 13:		Line 13:
	* list_name		* list_name
	* list_date		* list_date
-	* list_type ''(possible values ~~are~~: 0 ~~[standard]~~, 1 ~~[not deletable]~~)''	+	* list_type - ''possible values: 0, 1 (cannot update or delete)''

	=== Example Responses ===		=== Example Responses ===

WikiSysop: Created page with '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 …'

WikiSysop — Thu, 22 Jul 2010 05:24:28 GMT

Created page with '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 …'

New page

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 are: 0 [standard], 1 [not deletable])''

=== 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]]