Method returns list of groups and optionally product counts in CSV (tab delimited) format.
Optional input parameter is an array of tns:token, which contains groups identification tokens, language code of xsd:language (see ISO 639 for details - default is czech 'cs') and export option.
Output is an xsd:string, containing list of groups and optionally product counts.
Method accepts language, array of tokens and option. Also the method is ready to accept completely empty request. Any authorized client should send an array of requested group(s) information, but only some clients may send it empty, because there is usually no reason for doing so.
| group ID | parent ID (if present) | group name | products count (optional) |
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 |
|---|---|---|---|
| -1 | SERVICE | Empty catalog. | timestamp |
| -2 | SERVICE | Empty catalog. | timestamp |
| 1 | CLIENT | Malformed request, language not available. | selected language |
| 2 | CLIENT | Malformed request, group not found. | group token |
| 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/getGroupsStr" |
| Content-Length: | 723 |
| 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: | 30494 |
| 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.