checkWsAvailability(context)

Note:

To access the LATAM E-Document Certification SuiteApp documentation in Brazilian Portuguese (Português do Brasil), see LATAM E-Document Certification.

Function Declaration	`checkWsAvailability(context)`
Type	Interface function
Description	Checks the availability of the tax authority's certification web service. This optional function works with the Certification Web Services Availability portlet. It enables you to customize the validation that the portlet runs to check the availability of the web services. By default, the Certification Web Services Availability portlet makes a standard HTTP GET request to the web service URL associated with the send e-document operation. The portlet considers that a web service is available when the HTTP status code returned is 200, 299, or 405.
Returns	checkWsAvailabilityContext

Example

           /**
    *
    * Checks the availability of the tax authority's certification web service.
    *
    * @param {Object} context
    * @param {number} context.taxAuthId
    * @param {string} context.taxAuth
    * @param {string} context.url
    * @param {number} context.operationId
    * @param {number} context.subsidiary
    * @param {string} context.subsidiaryName
    * @param {number} context.category
    * @param {number|string} context.certificationEnvironment
    *
    * @returns {object} CheckWsAvailabilityResult
    * @returns {‌http.ClientResponse} CheckWsAvailabilityResult.response    
    * @returns {number} CheckWsAvailabilityResult.status
    */
    function checkWsAvailability(context) {
        //1 for available, 2 for unavailable
        return {
            response: {code: 200, headers: null, body: ""},
            status: 1 
        };
    };

General Notices