Documentation::getVendors

Method returns list of vendors and optionally product counts.

Optional input parameter is a 3D array of tns:vendorsRequest, which contains language, valid vendor identification tokens and export option.

Output is a multidimensional array (struct) of tns:vendors, containing xsd:token, xsd:string and xsd:nonNegativeInteger, vendor identification tokens, vendor names and optional product counts for selected vendor(s).

Limits

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 vendor information, but only some clients may send it empty, because there is usually no reason for doing so.

Fault codes

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
-1SERVICEEmpty catalog.timestamp
-2SERVICEEmpty catalog.timestamp
1CLIENTMalformed request, language not available.selected language
2CLIENTMalformed request, vendor not found.vendor token
ORA-[0-9]{1-5}DATABASEDatabase subsystem error.database error message

Authentication

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.

Example request

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/getVendors"
Content-Length:840

Example response

HTTP/1.1 200 OK
Date:Sat, 14 Jul 2007 11:31:36 GMT
Server:Apache
X-SOAP-Server:NuSOAP/0.6.8 (1.76)
Content-Length:1021
Connection:close
Content-Type:text/xml; charset=UTF-8

Known bugs

SOAP fault is returned in ISO-8859-1 encoding, except of server header UTF-8 charset declaration.