WAN Manager SPI Programming Guide

Commands and Response Tokens
WAN Manager SPI Programming Guide—540013-001
4-6
Description of Body Tokens
ZSPI-TKN-CONTEXT
acts as a response continuance indicator. If a response cannot fit into the SPI
response buffer, this token is present in the curtailed response. This token is also
required in the next command to retrieve the remaining response information.
ZSPI-TKN-DATALIST and ZSPI-TKN-ENDLIST
ZSPI-TKN-DATALIST indicates the beginning of a data list. One response record is
contained in each data list. ZSPI-TKN-ENDLIST indicates the end of the data list.
These tokens are used only when a value other than 0 (zero) is specified in the
command ZSPI-TKN-MAXRESP. If the ZSP-TKN-MAXRESP value is other than 0
(zero) and there are multiple responses, there might be multiple data lists
(response records) in the response.
ZSPI-TKN-ERRLIST
indicates the beginning of an error list. ZSPI-TKN-ENDLIST indicates the end of
the error list, and the error list can be nested. An error list is put in the response for
each error or warning encountered during processing of the command. The
required tokens for the error list are:
ZSPI-TKN-ERROR
specifies the error and identifies the subsystem that prepared the error list.
ZCOM-TKN-OBJTYPE
specifies the object type of the object in error.
ZCOM-TKN-OBJNAME
specifies the name of the object in error. Other standard or subsystem-specific
tokens can also be in the error list, depending on the type of error.
ZSPI-TKN-RETCODE
contains the return code, which indicates the outcome of command processing. If
the value is 0 (zero) (ZCOM-ERR-OK), the command completes without error. If
the value is not 0 (zero), an error has occurred, and the response record contains
an error list that describes the error.