Get Interest Profile API

Get Interest Profile API

Description

Get details for a specific interest profile

Security

Logged in user has interest profile API permissions

URL

Parameters        

  1. interestProfileId: [Required, part of URL] interestProfile to retrieve

Response

Name of new api

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

Example

Notes

{                                                                                                                                         
"id": 0,
"code": "string",
"active": true,
"interestProfileDetailsLink": {
"description": "string",
"url": "string"
} 

Error Codes

HTTP Status Code
Type
200
OK (Success)
400
Bad Request (request format error)
401
Unauthorised (not Authenticated)
403
Forbidden (invalid Authorisation)
404
Account Type not found
503
Service Unavailable (due to maintenance)


    • Related Articles

    • 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? ...

    • 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 ...

    • Create Interest Profile API

      Description Add a new interest profile Security Logged in user has client API permissions URL POST http://example.com/api/interestProfiles/CreateInterestProfile Parameters CreateInterestProfileRequest Field Type Description code String The interest ...

    • 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 ...