WEBGetSystemOptions

This method returns all the system options relevant to external systems.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>df3d1644-ba3e-4dc7-8399-ae06ee6063e5</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBGetSystemOptions/>
</soapenv:Body>
</soapenv:Envelope>

Sample Response

Shortened for brevity.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>df3d1644-ba3e-4dc7-8399-ae06ee6063e5</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBGetSystemOptionsResponse xmlns="http://www.avectra.com/2005/">
<WEBGetSystemOptionsResult>
<Results recordReturn="35">
<Result>
<fws_key>ae10b914-134f-482d-b53b-5069b604b233</fws_key>
<fws_option>BaselineWebSectionKey</fws_option>
<fws_value>7519c5f6-c234-4042-9ea2-81cfb69a041a</fws_value>
<fws_option_type>TextBox</fws_option_type>
<fws_option_values/>
<fws_option_desc>Changing this system option is NOT recommended. This system option is the key for the main section in the Baseline Website. By generating other websites from the Baseline Website, this section will ALWAYS be included and should have the "Homepage" in it.</fws_option_desc>
</Result>
<Result>
<fws_key>2cb6480d-eb0e-4a7e-af6a-690ee588802b</fws_key>
<fws_option>BaselineWebSiteKey</fws_option>
<fws_value>071d1f06-7b13-4f73-85f2-e66fd7e6ba54</fws_value>
<fws_option_type>TextBox</fws_option_type>
<fws_option_values/>
<fws_option_desc>Changing this system option is NOT recommended. 
 
This system option is the key for the Baseline Website (all other websites will be generated from this website).</fws_option_desc>
</Result>
<Result>
<fws_key>8cf7f093-e390-4a9b-9091-f74d8e42f45f</fws_key>
<fws_option>CacheRootFolder_eWeb</fws_option>
<fws_value/>
<fws_option_type>TextBox</fws_option_type>
<fws_option_values/>
<fws_option_desc>Identifies the file system folder that eWeb uses as the root folder for the netFORUM Cache.  If left blank, the CacheRootFolder system option value is used.  The default value is ..\\CacheRoot\\Cache</fws_option_desc>
</Result>
</Results>
</WEBGetSystemOptionsResult>
</WEBGetSystemOptionsResponse>
</soap:Body>
</soap:Envelope>

JSON Method

Pass in the token for a user to immediately expire the token.

Note: in the spec, this call is recommended for the "PasswordRegex" system option value. However, by default this system option does not return in this API call. The "eWeb" flag must be checked on the system option using netForum iWeb so that this system option will return in the API call.

GET /xweb/JSON/WEBGetSystemOptions

POST /xweb/JSON/WEBGetSystemOptions

DATA: JSON
{
    "WEBGetSystemOptions": null
}

SAMPLE RESULT
HTTP STATUS: 200
{
    "Results": {
        "@recordReturn": "25",
        "Result": [
            {
                "fws_key": "0bed3b57-898d-4899-b077-f524612609d5",
                "fws_option": "DefaultWebGiftSourceCode",
                "fws_value": null,
                "fws_option_type": "TextBox",
                "fws_option_values": null,
                "fws_option_desc": "This is used for default eWeb gift source code."
            },
            {
                "fws_key": "5ec2e6fb-d706-4622-8ad8-9b1b5b837e16",
                "fws_option": "EnableAskForDonationOneWebCheckout",
                "fws_value": "FALSE",
                "fws_option_type": "CheckBox",
                "fws_option_values": null,
                "fws_option_desc": "This determines if the Add Gift form should be presented to the user during checkout on eWeb.\r\nBy Default it is false."
            },
            {
                "fws_key": "d1902346-869a-4c35-a5af-59178e93a4d3",
                "fws_option": "EnableEwebInstallmentPayments",
                "fws_value": "true",
                "fws_option_type": "CheckBox",
                "fws_option_values": null,
                "fws_option_desc": "This option allows installment payments feature to be turned on in external web (eWeb). Keep in mind, installment payments schedules must be setup in iWeb in order for the payment option to be visible in eWeb."
            },
            {
                "fws_key": "2983b504-8e62-4803-8494-21f302ada457",
                "fws_option": "PasswordRegex",
                "fws_value": "^(?=.*[0-9]+.*)(?=.*[a-zA-Z]+.*)[A-Za-z0-9!@#%^&*()_]{4,8}",
                "fws_option_type": "DropDownList",
                "fws_option_values": "^(?=.*[0-9]+.*)(?=.*[a-zA-Z]+.*)[A-Za-z0-9!@#%^&*()_]{6,14}: 6-14 characters, digit required;\r\n^(?=.*[0-9]+.*)(?=.*[a-zA-Z]+.*)[A-Za-z0-9!@#%^&*()_]{4,8}:4-8 characters, digit required;\r\n^([A-Za-z0-9!@#%^&*()_]{2,18}?): Weak Password, 2-18 characters, no special characters.;",
                "fws_option_desc": "Provides a regular expression field for passwords to check against."
            }
        ]
    }
}