Get All Interest Profiles API

Description

Get a list of all interest profiles in the system

Security

Logged in user has interest profile API permissions

URL

GET http://exampleserver.com/api/ interestProfiles? interestProfileCode={interestProfileCode}&interestProfileDescription={interestProfileDescription}&activeOnly={false}

1. interestProfileCode: [string, optional] search for interest profile by code       
   
2. interestProfileDescription: [string, optional] search for interest profile by description       
   
3. activeOnly: [optional] restrict list to active interest profiles
   

Response

Interest Profile Response

Field	Type	Description
InterestProfiles	Array[InterestProfilesOverviewDto]	The list of results if successful, null otherwise

InterestProfileOverviewDto

Field	Type	Description
id	Integer	The interest profile Id
code	String	The interest profile code
active	Boolean	True if the interest profile is active
interestProfileDetailsLink	Link	URL for the interest profile details

Example

{                                                                                                                                       

"id": 0,

"code": "string",

"active": true,

"interestProfileDetailsLink": {

      "description": "string",

      "url": "string"

      }

} 

Error Codes

HTTP Status Code	Type
200	OK (Success)
204	No Content (no records match the search)
401	Unauthorised (not Authenticated)
403	Forbidden (invalid Authorisation)
503	Service Unavailable (due to maintenance)

Online Documentation

https://api.argos.co.nz/WebApi/swagger/ui/index#!/InterestProfiles

• Related Articles

• Get Interest Profile API

  Description Get details for a specific interest profile Security Logged in user has interest profile API permissions URL GET http://exampleserver.com/api/ interestProfiles/{ interestProfileId} Parameters interestProfileId: [Required, part of URL] ...

• Argos Vault Release Notes V5.151

  Release Completion Date: ? Important Notes Please disregard modules listed in these release notes that are not relevant to your usage. For additional details on any change, refer to the [Help] button within the relevant dialog—unless otherwise ...

• Argos Vault Release Notes V5.144

  Release Completion Date: 17/05/2024 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] button. Other documents referred to in the ...

• Get Account Details API

  Description Retrieve the system specific details for an account Security Logged in user has account API permissions URL GET http://exampleserver.com/api/{system}/{accountId}?calculationDate=date Parameters system: [Required, part of URL] One of (case ...

• Get All Clients API

  Description Get a list of all clients in the system Security Logged in user has client API permissions URL GET http://exampleserver.com/api/v6/clients?clientCode={clientCode}&clientName={clientName}&activeOnly={false}&groupCode={groupCode} Parameters ...