|
Welcome to Iress Open Release Number 3
|
Release Number: 3
This release sees the creation of version 3 (V3) of the Standard Iress Open API. V3 includes a number of additional new data points, and changes to the use of some pre-existing ones, which are detailed below. Many of these changes are integrator / client driven following feedback from our users.
Version 2 will continue to be supported, however 1 will be withdrawn in the second half of this year. We will write to impacted parties separately about this.
To take advantage of the changes please see the swagger documentation for full details, by selecting version 3 from the drop down:
https://api.iressopen.co.uk/swagger/index.html?urls.primaryName=3.0
https://api.iressopen.com.au/swagger/index.html?urls.primaryName=3.0
https://api.uat.iressopen.co.za/swagger/index.html?urls.primaryName=3.0
Contents
Features
Locale: Global
Include Prospects and other client statuses in Client endpoint
Reference XI-2670
For ClientStatus, under the Client endpoint, it was previously only possible to call entities that had a status of Client in Xplan. We have had requests to include other statuses such as Prospect or Deceased, so all options are now available for this field.
When calling ClientStatus you will now have options of Client, Archived, GroupPlanMembers, Prospect, Contact and Deceased, which you can pass in with a value of true or false for each option. The option(s) included will determine the client type(s) for which you will receive results. If you leave the call as before you will continue to receive entities with a status of client only.
|
Swagger Location
|
Swagger Name
|
Field Type
|
|
Client
|
ClientStatuses
ClientStatusDescriptions
|
Integer
String
|
Allow PATCH Docnote and PATCH/DELETE of attachments in DocumentNote endpoint
Reference XI-2640
Previously we only offered POST and this was a combined POST of Docnote and Attachments. To allow the attachments and the docnote to be amended, we now allow the user to retrieve the attachment id's (DocPartId) and to DELETE/PATCH docnotes and individual attachments.
Fund and Stock Identification
Reference XI-2631
The use of ISIN for US instruments can be subject to licensing costs so as an added protection, US ISIN codes will be replaced by the corresponding SEDOL code, where no SEDOL is available the security description will be used.
|
Swagger Location
|
Swagger Name
|
Field Type
|
|
Portfolio
|
SEDOL
|
String
|
Locale: AU
Additional Call for Investments in Superannuation and Retirement Income endpoints
Reference XI-2632
In Xplan, it is possible to add funds directly to both the Superannuation plan and the Retirement Income plan, in addition to those added and linked via the Portfolio associate. We have now added the further calls for GET under Superannuation and Retirement Income:
- Get investment options for plan (Investmentoption)
- Get investment option by ID (Investmentoption/InvestmentOptionId)
|
Fields
|
Field Type
|
|
Id
|
Integer
|
|
Name
|
String
|
|
Type
|
String
|
|
TypeDescription
|
Sting
|
|
OptionSpin
|
String
|
|
AllocatedAmount
|
Number
|
|
AllocatedPercent
|
Number
|
|
AllocationEffectiveDate
|
String
|
MiFIDNationality Field
Reference XI-2665
We have added the nationality field for AU. This is already present for other locales.
|
Swagger Location
|
Swagger Name
|
Field Type
|
|
Client/IndividualDetails
|
MiFIDNationality
MiFIDNationalityDescription
|
String
|
Health Fields
Reference XI-2633 and XI-2676
We have added a new section to the Client endpoint called HealthDetails. We have also added the following new fields.
|
Swagger Location
|
Swagger Name
|
Field Type
|
|
Client/HealthDetails
|
HealthStatus
HealthStatusDescription
|
String
|
|
Client/HealthDetails
|
MedicalHistory
|
String
|
Locale: UK
Agency in Your Name fields now available
Reference XI-2634
We have added the Agency in your name fields to the locations (endpoints) below. These fields allow an Xplan user to record (at plan level) if their firm is responsible for the advice given.
|
Swagger Location
|
Swagger Name
|
Field Type
|
|
Assets
|
AgencyInYourName
|
Bool
|
|
Life
|
AgencyInYourName
|
Bool
|
|
General
|
AgencyInYourName
|
Bool
|
|
Medical
|
AgencyInYourName
|
Bool
|
|
Pensions
|
AgencyInYourName
|
Bool
|
|
RetirementIncome
|
AgencyInYourName
|
Bool
|
Health Fields
Reference XI-2668
We have changed the name of the Client / HealthDetails field to HealthComment to ensure consistency with field names in Xplan. It is still the same underlying field and API. Also a further field called MedicalHistory has been added.
|
Swagger Location
|
Swagger Name
|
Field Type
|
|
Client/HealthDetails
|
HealthComment (was called HealthDetail)
|
String
|
|
Client/HealthDetails
|
MedicalHistory
|
String
|
Locale: ZA
Health Fields
Reference XI-2677
We have changed the name of the Client / HealthDetail field to MedicalHistory to ensure consistency with field names in Xplan. It is still the same underlying field and API.
|
Swagger Location
|
Swagger Name
|
Field Type
|
|
Client/HealthDetails
|
MedicalHistory (was called HealthDetail)
|
String
|
Additional Features
Locale: Global
New Risk Rating Endpoint
Reference XI-2628
We have added this endpoint to enable users to GET and PATCH Risk Profiles. It now possible to:
GET client risk ratings from Xplan for the Xplan site and for an individual client, partner, joint or client group
|
Swagger Location
|
Swagger Name
|
Field Type
|
|
RiskRating/Client
RiskRating/Partner
RiskRating/Joint
RiskRating/ClientGroup
|
RiskProfileId
|
Integer
|
|
RiskRating/Client
RiskRating/Partner
RiskRating/Joint
RiskRating/ClientGroup
|
EntityId
|
Integer
|
|
RiskRating/Client
RiskRating/Partner
RiskRating/Joint
RiskRating/ClientGroup
|
Name
|
String
|
|
RiskRating/Client
RiskRating/Partner
RiskRating/Joint
RiskRating/ClientGroup
|
Description
|
String
|
|
RiskRating/Client
RiskRating/Partner
RiskRating/Joint
RiskRating/ClientGroup
|
RiskProfileId
|
Integer
|
|
RiskRating/Client
RiskRating/Partner
RiskRating/Joint
RiskRating/ClientGroup
|
Reason
|
String
|
|
RiskRating/Profile
|
Id
|
Integer
|
|
RiskRating/Profile
|
Name
|
String
|
|
RiskRating/Profile
|
Description
|
String
|
PATCH risk ratings that were created in my application back to Xplan, e.g. a change from Moderate to Cautious. updating the client, partner, joint or client group record in Xplan
PATCH risk ratings that were created in my application back to Xplan, e.g. create a risk rating for the client, partner, joint or client group record in Xplan
|
Swagger Location
|
Swagger Name
|
Field Type
|
|
RiskRating/Client
RiskRating/Partner
RiskRating/Joint
RiskRating/ClientGroup
|
RiskProfileId
|
Integer
|
|
RiskRating/Client
RiskRating/Partner
RiskRating/Joint
RiskRating/ClientGroup
|
Reason
|
String
|
New Consent Endpoint
Reference XI-2626
We have added the Xplan Consent fields in all locales. These fields allow you to record a client’s marketing preferences in Xplan and can be used in the event that a mailout is created. For example, a client may be happy to receive communications regarding markets and investments, but not life assurance. Clients can therefore be included or excluded depending on what consents are recorded.
|
Swagger Location
|
Swagger Name
|
Field Type
|
|
Consent
|
Id
|
Integer
|
|
Consent
|
Description
|
String
|
|
Consent
|
Content
|
String
|
|
Consent
|
PurposesOfConsent
|
String
|
|
Consent
|
PurposesOfConsentDescription
|
String
|
|
Consent
|
CreatedDate
|
Date
|
|
Consent
|
AgreedDate
|
Date
|
|
Consent
|
ExpiryDate
|
Date
|
Resolved Issues
| Endpoint / Field |
Resolved Issues |
Reference
Locale
|
|
Income / OwnerType
|
Income Endpoint : Owner Value Incorrect
Previously the data type for this field was incorrectly set to Date. It has now been changed to the correct type, which is Text
|
XI-2652
Global
|
|
Objectives / Type
|
Remove 'Type' fields from Objectives section in Iress Open Standard AU
This field was introduced in error and as a non-standard field fails to work on many Xplan sites. We have removed it from the Iress Open Standard framework.
If you are using this field you will need to remove it from your integration in order to adopt V3
|
XI-2639
AU
|
|
Client / Communication Preferences
|
Change Communication Preferences to Choice fields
Previously the Communication fields were incorrectly set to Boolean. They have now been changed to be the correct type which is Choice
If you are using this field you will need to update it in order to adopt V3. You can obtain a list of options available from the GET/Client/Options end point.
|
XI-2623
UK
|
