MessageSetAggregate Property

Wrapper for a message set.

Object Oriented Interface

public function getMessageSetAggregate($messagesetindex);

Procedural Interface

ipworksofx_fiprofile_get($res, 31 , $messagesetindex);

Default Value

''

Remarks

Wrapper for a message set.

A list of all of a given Financial Institution's supported services are stored in a series of aggregates called 'Message Sets'.

Each message set aggregate contains data (elements and values) associated with the following properties:

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The $messagesetindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 PHP Edition - Version 20.0 [Build 7941]