Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Get a list of available delivery report names.

Example successful response body XML:

Code Block
languagexml
themeRDark
languagexml
linenumberstrue
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE response PUBLIC
"-//textmarketer.co.uk//DTD Web Services REST 1.6//EN"
"http://api.textmarketer.co.uk/services/rest/DTD/deliveryreports_get.dtd">
<response processed_date="2011-04-14T14:42:40+01:00">
	<userdirectory>SIDHOSS7F7FDS89F</userdirectory>
	<reports quantity="30" >
		<report name="GatewayAPI_14-04-11" last_updated="2011-04-
		14T12:05:02+01:00" extension="csv"/>
		<report name="myCampaign" last_updated="2011-04-13T12:50:01+01:00" 
		extension="csv"/>
	</reports>
</response>

Response meanings:

XML tag/attribute Meaning
userdirectory DEPRECATED – this value no longer has any meaning.
reportsContains a list of delivery report names, file extension and last-modified dates.
quantity The number of delivery reports available.
report Details of an individual delivery report.
name The name of an individual delivery report.
last_updated 

The date that an individual delivery report was last updated, in ISO8601 format.
This allows you to determine whether there was a change since you last accessed the report.

extension DEPRECATED – this value no longer has any meaning

Specific errors:

None. 

DTD for deliveryReports GET:

Code Block
languagexml
themeRDark
languagexml
linenumberstrue
<?xml version="1.0" encoding="UTF-8"?>
<!--
 PUBLIC ID : -//textmarketer.co.uk//DTD Web Services REST 1.6//EN

SYSTEM ID : 
http://api.textmarketer.co.uk/services/rest/DTD/deliveryreports_get.dtd
-->
<!ELEMENT response (userdirectory, reports)>
<!ATTLIST response
 	processed_date CDATA #REQUIRED
>
<!ELEMENT userdirectory (#PCDATA)>
<!ELEMENT reports (report*)>
<!ATTLIST reports
 	quantity CDATA #REQUIRED
>
<!ELEMENT report (#PCDATA) >
<!ATTLIST report
 	name CDATA #REQUIRED
 	last_updated CDATA #REQUIRED
 	extension CDATA #REQUIRED
>