SendRequest Event

Fires when QuickBooks Web Connector asks for a request.

Syntax

• C#
• VB.NET

public event OnSendRequestHandler OnSendRequest;

public delegate void OnSendRequestHandler(object sender, QbwcserverSendRequestEventArgs e);

public class QbwcserverSendRequestEventArgs : EventArgs {
  public string SessionTicket { get; }
  public string CompanyResponse { get; }
  public string HostResponse { get; }
  public string PrefsResponse { get; }
  public string CompanyFile { get; }
  public string QBXMLCountry { get; }
  public int QBXMLMajorVersion { get; }
  public int QBXMLMinorVersion { get; }
  public string Request { get; set; }
}

Public Event OnSendRequest As OnSendRequestHandler

Public Delegate Sub OnSendRequestHandler(sender As Object, e As QbwcserverSendRequestEventArgs)

Public Class QbwcserverSendRequestEventArgs Inherits EventArgs
  Public ReadOnly Property SessionTicket As String
  Public ReadOnly Property CompanyResponse As String
  Public ReadOnly Property HostResponse As String
  Public ReadOnly Property PrefsResponse As String
  Public ReadOnly Property CompanyFile As String
  Public ReadOnly Property QBXMLCountry As String
  Public ReadOnly Property QBXMLMajorVersion As Integer
  Public ReadOnly Property QBXMLMinorVersion As Integer
  Public Property Request As String
End Class

Remarks

This event fires when QuickBooks Web Connector is ready to accept a request. The purpose of the event is to provide a request to QuickBooks Web Connector. The parameters are as follows:

SessionTicket identifies the session. This value is read-only.

CompanyResponse holds a QBXML response to a Company Query. This is automatically provided by QuickBooks Web Connector the first time this event fires for a session and may be passed to the QBResponseAggregate property of the Company component. This value is read-only.

HostResponse holds a QBXML response to a Host Query. This is automatically provided by QuickBooks Web Connector the first time this event fires for a session and may be passed to the QBResponseAggregate property of the Company component. This value is read-only.

PrefsResponse holds a QBXML response to a Preferences Query. This is automatically provided by QuickBooks Web Connector the first time this event fires for a session and may be passed to the QBResponseAggregate property of the Company component. This value is read-only.

CompanyFile specifies the path to the company file that will be used in the data exchange. This value is read-only.

QBXMLCountry is the country version of QuickBooks. For instance "US", "CA", or "UK". This value is read-only.

QBXMLMajorVersion is the major version of the qbXML request processor (QBSDK version). For instance if the qbXML specification version is "6.0" this value will be "6". This value is read-only.

QBXMLMinorVersion is the minor version of the qbXML request processor (QBSDK version). For instance if the qbXML specification version is "6.0" this value will be "0". This value is read-only.

Request specifies the qbXML request that will be sent to QuickBooks Web Connector. This may be obtained from other components in the toolkit by setting the QBRequestMode property to Offline. See the help for QBRequestMode for mode details.

Note: If the Request parameter is left empty QuickBooks Web Connector will then make a call and GetLastError will fire. This approach may be used if you wish to return an error, request interactive mode, or introduce a brief pause.