proactive-deps
    Preparing search index...

    Type Alias SoapCheckDetails

    Defines the structure of a SOAP check.

    const soapCheckDetails: SoapCheckDetails = {
      type: 'soap',
      wsdlUrl: 'http://example.com/service?wsdl',
      method: 'GetUserInfo',
      headers: {
        'Content-Type': 'text/xml; charset=utf-8',
        'SOAPAction': 'http://example.com/GetUserInfo',
      },
      body: '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><GetUserInfo xmlns="http://example.com/"/></soap:Body></soap:Envelope>',
      timeoutMs: 5000,
      expectedStatusCode: 200,
      expectedResponseBody: '<UserInfoResponse>...</UserInfoResponse>',
    };
    type SoapCheckDetails = {
        body?: string;
        expectedResponseBody?: string;
        expectedStatusCode?: number;
        headers?: Record<string, string>;
        method: string;
        timeoutMs?: number;
        type: "soap";
        wsdlUrl: string;
    }
    Index

    Properties

    body? expectedResponseBody? expectedStatusCode? headers? method timeoutMs? type wsdlUrl

    Properties

    Optionalbody

    body?: string

    Optional body being sent in the request. Be careful not to expose any sensitive information here. These are just examples.

    expectedResponseBody?: string

    Optional description of value in response body being checked for.

    expectedStatusCode?: number

    Optional expected HTTP status code for a successful response.

    headers?: Record<string, string>

    Optional headers being included in the request. Do not expose real authentication tokens here. These are just examples.

    method: string

    The SOAP method being called.

    timeoutMs?: number

    Optional timeout in milliseconds for the request.

    type: "soap"
    wsdlUrl: string

    Settings

    Member Visibility

    On This Page

    Properties