Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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.
Example successful response body XML:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?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/groups_get.dtd"> <response processed_date="2011-04-14T16:32:40+01:00"> <group name="MyGroup1" numbers="4" id="1" is_stop="false"> <number>447123000001</number> <number>447123000002</number> <number>447123000003</number> <number>447123000004</number> </group> </response> |
Response meanings:
| 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' – true/false. |
| numbers | The quantity of numbers present in the group. |
| number | A number present in the group. |
Specific errors:
| Code | Meaning |
|---|---|
| 0 | DEPRECATED – status code 400 (bad request) is returned instead. |
| Note |
|---|
E that a 404 status code is returned if the group specified does not exist; 400 is returned if the group name was not specified. |
DTD:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?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/group_get.dtd --> <!ELEMENT response (group)> <!ATTLIST response processed_date CDATA #REQUIRED > <!ELEMENT group (number*) > <!ATTLIST group name CDATA #REQUIRED numbers CDATA #REQUIRED id CDATA #REQUIRED is_stop CDATA #REQUIRED > <!ELEMENT number (#PCDATA) > |
| Panel |
|---|
Next: group GET POST method |