Method returns list of groups. Parent, which is some kind of top level root, should be requested by the client.
Optional input parameter is a 3D array of xsd:token, which contains valid parent identifications and selected language of xsd:language (see ISO 639 for details). Default language is czech (cs), if none selected.
Output is a multidimensional array (struct) of tns:groups, containing xsd:token (twice), xsd:string and one xsd:boolean, group identifications, optional parent identifications and group names.
Method accepts array with only language (or empty request) selected for some authorized clients. This results to output of full list of all available groups. Any authorized client should send an array with one parent and a language, which is much faster.
Method returns SOAP fault (according to SOAP Version 1.2, section 2.3 Fault Scenarios) on failure or when no data found for client request. Database error may be returned with specific error prefix, when database is not ready or something unwanted happens.
| Code | Actor | String | Detail |
|---|---|---|---|
| -9 | SERVICE | Unhandled exception. | current parent |
| -2 | SERVICE | Empty catalog. | timestamp |
| -1 | SERVICE | No groups found. | timestamp |
| 1 | CLIENT | Malformed request, language not available. | selected language |
| 2 | CLIENT | Malformed request, unknown parent identification. | selected parent |
| ORA-[0-9]{1-5} | DATABASE | Database subsystem error. | database error message |
SOAP client must be capable of basic HTTP authentication to use this method.
Some clients may be authorized to use only some part(s) of this method, so it is the client's responsibility to use only such request. Otherwise the request will not be authorized and HTTP 401 will be returned.
| POST /index.php HTTP/1.0 | |
|---|---|
| User-Agent: | ClTest/1.0.0 (0.99) |
| Host: | xchgdemo.techdata.cz |
| Content-Type: | text/xml; charset=UTF-8 |
| SOAPAction: | "http://xchgdemo.techdata.cz/index.php/getGroups" |
| Content-Length: | 756 |
| HTTP/1.1 200 OK | |
|---|---|
| Date: | Thu, 12 Jul 2007 06:59:13 GMT |
| Server: | Apache |
| X-SOAP-Server: | NuSOAP/0.6.8 (1.76) |
| Content-Length: | 27206 |
| Connection: | close |
| Content-Type: | text/xml; charset=UTF-8 |
SOAP fault is returned in ISO-8859-1 encoding, except of server header UTF-8 charset declaration.