group GET method

=20

Shows the details of a group. It will display the same group information= as the 'groups GET' method, except that it shows only one group, and = includes all the numbers in the group, if there are any.

=20

Example successful response body XML:

=20

<?xml version=3D"1.0" encoding=3D"ISO-8859-1"?&=
gt;
<!DOCTYPE response PUBLIC
"-//textmarketer.co.uk//DTD Web Services REST 1.6//EN"
"http://api.textmarketer.co.uk/services/rest/DTD/groups_get.dtd"&=
gt;
<response processed_date=3D"2011-04-14T16:32:40+01:00">
=09<group name=3D"MyGroup1" numbers=3D"4" id=3D"=
;1" is_stop=3D"false">
=09=09<number>447123000001</number>
=09=09<number>447123000002</number>
=09=09<number>447123000003</number>
=09=09<number>447123000004</number>
=09</group>
</response>

=20

Response meanings:

=20

XML tag/attribute	Meaning
group	Details of the group.
name	The name of the group. Up to 25 characters.
id	The unique ID of the group.
is_stop	Whether or not this is a 'stop group' =E2=80= =93 true/false.
numbers	The quantity of numbers present in the group.=
number	A number present in the group.

=20

Specific errors:

=20

Code	Meaning
0	DEPRECATED =E2=80=93 status code 400 (bad req= uest) is returned instead.

=20 =20

E that a 404 status code is returned if the group specified does not exi= st; 400 is returned if the group name was not specified.

=20

DTD:

=20

<?xml version=3D"1.0" encoding=3D"UTF-8"?>
<!--
 =09PUBLIC ID : -//textmarketer.co.uk//DTD Web Services REST 1.6//EN
 =09SYSTEM ID : http://api.textmarketer.co.uk/services/rest/DTD/group_get.d=
td
-->
<!ELEMENT response (group)>
<!ATTLIST response
 =09processed_date CDATA #REQUIRED
>
<!ELEMENT group (number*) >
<!ATTLIST group
 =09name CDATA #REQUIRED
=09numbers CDATA #REQUIRED
 =09id CDATA #REQUIRED
 =09is_stop CDATA #REQUIRED
>
<!ELEMENT number (#PCDATA) >

=20

Next: group POST method

Home: All Documentation

=20