QueryWebFwdList

Query list of web forwards

Possible Gateways

The command QueryWebFwdList is available via the following gateways:

Required Parameters

The following parameters are standard parameters for this command.

Command

COMMAND = QueryWebFwdList

Response

code                = [INT]
description         = [TEXT]
property[WEBFWD][n] = [TEXT]
property[COUNT][0]  = [INT]
property[FIRST][0]  = [INT]
property[LAST][0]   = [INT]
property[LIMIT][0]  = [INT]
property[TOTAL][0]  = [INT]

Attributes

WEBFWD	Forwarding
COUNT	Total number of forwardings shown
FIRST	Pointer to the first shown ID
LAST	Pointer to the last shown ID
LIMIT	The limit given in the command
TOTAL	Total number of existing forwardings
CLTRID	The transaction - ID given in the request where this response is the answer for; Will only be returned if a CLTRID was given in the request
SVTRID	A unique ID for this request generated by the server; Will only be returned if a CLTRID was given in the request

Optional

The following parameters are optional for this command.

Command

COMMAND = QueryWebFwdList
WIDE    = [TEXT]
SOURCE  = [TEXT]
TARGET  = [TEXT]
TYPE    = [TEXT]
FIRST   = [INT]
LIMIT   = [INT]
ORDER   = ASC | DESC
ORDERBY = source | target | type
CLTRID  = [TEXT]

Response

code                = [INT]
description         = [TEXT]
property[SOURCE][n] = [TEXT]
property[TARGET][n] = [TEXT]
property[TYPE][n]   = RD | MRD
property[COUNT][0]  = [INT]
property[FIRST][0]  = [INT]
property[LAST][0]   = [INT]
property[LIMIT][0]  = [INT]
property[TOTAL][0]  = [INT]
property[CLTRID][0] = [TEXT]
property[SVTRID][0] = [TEXT]

Attributes

WIDE	0\|1 (optional)
SOURCE	An optional parameter to filter by SOURCE. The property shows the zones to be forwarded. This will only be returned if WIDE=1 is sent.
TARGET	An optional parameter to filter by TARGET. The property shows the target of the forwarding (i.e. http://www.example.org). This will only be returned if WIDE=1 is sent.
TYPE	An optional parameter to filter by TYPE. The property shows the type of redirection used. This will only be returned if WIDE=1 is sent.
FIRST	Start the output of results from this item (optional)
LIMIT	Show only this many items in the response (optional) ORDER
ORDERBY	Order resulting list by this column (optional)
CLTRID	Unique identifier for this request, must be changed with every request, the default is auto-generated (optional)