Initial Settings - API

API Name: TX_INIT_SETTINGS

Overview:
 This API will return all of the relevant information in order to display a login page that will respect the web page setup in Presentation Themes.

OUTPUT PARAMETERS:

 

  Parameter                 Comment

 

    T_ERROR                   Returns a non-blank value if login unsuccessful.

 

    T_IMAGE_PATH              Relative path under ROTD Context on the web server that

                              contains all of the images to be displayed.

 

    T_LOGO_IMAGE              The name (if any) of the logo to be displayed.

 

    T_FONT                    The font to be used for the web pages.

 

    T_FOREGROUND_COLOR        The color to be used for the text within the web page headings.

 

    T_BACKGROUND_COLOR        The color to be used for the background of web page headings.

 

    T_LOGIN_HEADING           The text to be used as the customer login heading.

 

    T_PAGE_COLOR              The color to be used as the background color of the web pages.

 

    T_PAGE_IMAGE              The image to be used as the background image of the web pages.

                              This takes precedence over T_PAGE_COLOR if both have values.

 

    T_TEXT_COLOR              The color to be used for standard text.

 

    T_FORGOT_PASSWORD_ID      If the Web Administrator has given customers the ability to enter a

                              password question/answer (hint) by adding the Maintain Password Question
                              API to the web index, then the Index ID related to the

                              first instance of this API will be returned.

 

    T_DESC_FORGOT_PASSWORD    The description to be used for the forgot password hyperlink.

 

Topic Keyword: INITIAL_SETTINGS