List Sites - API

API Name: TX_LIST_SITES

Overview:
This API is designed to give your customers the ability to view Job Site information.

INPUT PARAMETERS:

   Parameter          Default Value         Comment

    T_WEB_ID                                 The unique Web Identification value

                                             returned by the Customer Login API.

    T_INDEX_ID          default              The Index ID associated with this API that

                                             defines the Modes and Fields available.

    T_LINES_PER_PAGE                         If you wish to limit the number of records

                                             returned as part of the record set, enter the

                                             maximum number of lines to be returned when a page

                                             is requested.

                                             If there is no limit required enter 0.

    T_PAGE                                   This parameter is to be used with the T_LINES_PER_PAGE

                                             parameter to determine which data is to be passed in

                                             the record set.  Pass 0 or blank for the initial call

                                             to build record set.

    T_CUST_N            Logged In Customer   The customer# for which the query is regarding.

    T_OPEN_SITES_ONLY   Y

    T_OPEN_FROM_DATE    January 1, 1901

    T_OPEN_TO_DATE      December 31, 2199

OUTPUT PARAMETERS:

  Parameter                 Comment

    T_ERROR                   If an error is encountered this will be returned as a non-blank value.

    T_NUM_PAGES               This will return the total number of pages generated based on the

                              T_LINES_PER_PAGE parameter which was passed in.

    T_PAGE                    The current page of data that has been returned in the record set.

    T_LIMIT_EXCEEDED          If the total number of records which are required to be listed exceed

                              the maximum allowed as set in Presentation Themes this will

                              return a non-blank value contain what limit has been exceeded. (ie.100)

RECORD SETS:

Record Set: ARST

  Column Names                 Comment

    Customer#

    Site#

    Site Name

    Address1

    Address2

    City

    Prov

    Postal

    Phone

    Purchase Order#

    Fax

    Contractor Name

    Open

    Open Date