on_receive_response Event

Fires when a response is received.

Syntax

class QBWCServerReceiveResponseEventParams(object):
  @property
  def session_ticket() -> str: ...
  @property
  def response() -> str: ...
  @property
  def error_code() -> str: ...
  @property
  def error_message() -> str: ...
  @property
  def success() -> bool: ...
  @property
  def percent_done() -> int: ...
  @percent_done.setter
  def percent_done(value) -> None: ...

# In class QBWCServer:
@property
def on_receive_response() -> Callable[[QBWCServerReceiveResponseEventParams], None]: ...
@on_receive_response.setter
def on_receive_response(event_hook: Callable[[QBWCServerReceiveResponseEventParams], None]) -> None: ...

Remarks

This event fires after on_send_request to provide the response of the request. The parameters are as follows:

SessionTicket identifies the session.

Response holds the qbXML response. This may be passed to the QBResponseAggregate property or InputQBXML method of other classs in this toolkit to parse the response. In the case of an error this parameter will be empty. This value is read-only.

ErrorCode holds the error code (HResult) returned by QuickBooks. This value is read-only.

ErrorMessage holds the error message returned by QuickBooks. This value is read-only.

Success indicates whether the request was processed successfully by QuickBooks. If this value is False check HResult and Message for details. This value is read-only.

PercentDone indicates the current progress to QuickBooks Web Connector. A value of 100 means there are no more requests to be processed for this session.

A positive value less than 100 indicates there is still more work to do in this session and QuickBooks Web Connector will make another call and on_send_request will fire again. There is no limit to the number of requests in a session, so you may continue to set this value to a positive number less than 100 to continue the session.

A negative value indicates and error and will cause on_get_last_error to fire.

The default value is 100, which indicates there is no more work to do for this session.