ofx_batch_item_response Property

The OFX response aggregate.

Syntax

def get_ofx_batch_item_response(ofx_batch_item_index: int) -> str: ...
def set_ofx_batch_item_response(ofx_batch_item_index: int, value: str) -> None: ...

Default Value

""

Remarks

The OFX response aggregate. This string represents the OFX response aggregate for the current ofx_batch_item_request. When the OFXBatch is posted, the ofx_batch_item_response property will be populated automatically with the server's response to the ofx_batch_item_request.

For example, if the batch request consisted of BankStatement, CCStatement and FIProfile, such as:

OFXBatch.OFXBatchItemCount = 3;
OFXBatch.OFXBatchItems[0].Request = BankStatement.OFXRequest;
OFXBatch.OFXBatchItems[1].Request = CCStatement.OFXRequest;
OFXBatch.OFXBatchItems[2].Request = FIProfile.OFXRequest;

Upon successful server response, the OFXResponse aggregate of the corresponding class should be set (in the same order as they were included in the batch request), for example:

BankStatement.OFXResponse = OFXBatch.OFXBatchItems[0].Response;
CCStatement.OFXResponse = OFXBatch.OFXBatchItems[1].Response;
FIProfile.OFXResponse = OFXBatch.OFXBatchItems[2].Response;

Properties of each class are now populated and ready for retrieval.

The ofx_batch_item_index parameter specifies the index of the item in the array. The size of the array is controlled by the ofx_batch_item_count property.