Read dimension

Reads a customer (dimension type DEB) with ProcessXml and shows what to do when Twinfield does not accept the request.

processXml() takes the request as XML string. Build it with an XML library, as Twinfield recommends, so values such as & are escaped. XmlBuilder makes that short: add($parent, $name, $value, $attributes) and toXml(). DOM, SimpleXML or XMLWriter work too, or a plain string: processXml('<read>…</read>'). Before sending, comments and whitespace between elements are removed, as Twinfield asks.

Twinfield marks the result of each element with a result attribute: 1 processed, 0 not. When the root element has result="0", processXml() throws a ProcessXmlException. Its result has the whole response, and messages() gives each error and warning (msg and msgtype) with the path of the element, e.g. dimension/code. In a bulk request (e.g. <transactions> with several transactions) the other elements may have been processed: check their result attribute.

Warnings on a processed request are in $result->warnings().

Code

$twinfield = Example::twinfield();

$code = $argv[1] ?? '1000';

// Build the request with XmlBuilder (DOM), so values are escaped.
$request = XmlBuilder::create('read');
$request->add($request->root(), 'type', 'dimensions');
$request->add($request->root(), 'office', (string) $twinfield->companyCode());
$request->add($request->root(), 'dimtype', 'DEB');
$request->add($request->root(), 'code', $code);

try {
    $result = $twinfield->processXml($request->toXml());
} catch (ProcessXmlException $exception) {
    foreach ($exception->result->messages() as $message) {
        echo $message->type->value, ' at ', $message->path, ': ', $message->text, PHP_EOL;
    }

    exit(1);
}

$xpath = $result->xpath();

echo 'Code:    ', $xpath->evaluate('string(/dimension/code)'), PHP_EOL;
echo 'Name:    ', $xpath->evaluate('string(/dimension/name)'), PHP_EOL;
echo 'Type:    ', $xpath->evaluate('string(/dimension/type)'), PHP_EOL;
echo 'Group:   ', $xpath->evaluate('string(/dimension/type/@name)'), PHP_EOL;
echo 'Status:  ', $xpath->evaluate('string(/dimension/@status)'), PHP_EOL;
echo 'Website: ', $xpath->evaluate('string(/dimension/website)'), PHP_EOL;

Run

php examples/process-xml/read-dimension/example.php 1000

Add TWINFIELD_DEBUG=1 to see the SOAP request and response.

Code:    1000
Name:    Example Customer B.V.
Type:    DEB
Group:   Debiteuren
Status:  active
Website: www.example.com

With a code that does not exist:

error at dimension/code: De code voldoet niet aan het formaat 1[0-9][0-9][0-9].

Source

View examples/process-xml/read-dimension/example.php on GitHub.