Versions Compared

Key

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

 

Get the availability of a specified reply keyword.

Example successful response body XML:

Code Block
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/keywords_get.dtd">
<response processed_date="2011-04-15T10:13:50+01:00">
<available>true</available>
<recycle>false</recycle>
</response>

Response meanings:

XML tagMeaning
available 

Whether or not the keyword is available for purchase.
Boolean: true/false.

recycle

Whether or not the keyword was used previously by another client.
Boolean: true/false.

Specific errors:

None.

Note

that a 400 (bad request) status code is returned if the keyword is not specified.

DTD:

Code Block
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/keywords_get.dtd
-->
<!ELEMENT response (available, recycle)>
<!ATTLIST response
	 processed_date CDATA #REQUIRED
>
<!ELEMENT available (#PCDATA) >
<!ELEMENT recycle (#PCDATA) >