GET api/user/{id}/settings

Get user's settings configured for a given user id.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/user/{id}/settings. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique identifier of a user.

integer

Required

Body Parameters

None.

Response Information

Response Codes

Success Status:

  • OK (200), please see resource description below.

Failed Status(es):

Resource Description

User's Settings configured.

UserSettingsDto
NameDescriptionTypeAdditional information
UserID

Unique Identifier of a User.

integer
UserName

User's Name.

string
ATM

Indicates whether user has access to ATM Transactions.

boolean
GLError

Indicates true if any GL related error.

boolean
LoanApprovalGroup

Loan Approval levels for a user.

LoanApprovalGroups
Administrator

Indicates whether the user is administratr or not.

boolean
PersonID

Unique Identifier of a User Person.

integer
LogonAnyBranch

Indicates access level of a user to other branches.

boolean
Notify

Indicates whether the user to be notified or not.

boolean
CUAccountPortfolioID

Unique Identifier of an account Portfolio to which user is mapped.

integer
Password

User's Password.

string
AllowApprove

Indicates whether user can approve loans.

boolean
AllowInterestOverride

Indicates whether user can override interest rate of a loan product.

boolean
AllowSavingsInterestOverride

Indicates whether user can override interest rate of a savings product.

boolean
PasswordLifetime

Indicates the duration of password.

integer
MenuItems

Menu options which user has access.

Collection of string
AllowMenuCustomise

Indicates whether user has access to customize menu options.

boolean
StartUpSessionInfo

Indictes whether SessionInfo to dispaly in User screen on application start up.

boolean
StartUpCustomerInfo

Indictes whether CustomerInfo to dispaly in User screen on application start up.

boolean
StartUpCalendarView

Indictes whether CalendarView to dispaly in User screen on application start up.

boolean
LoggedInTime

Logged in time of a user.

time interval
LoggedInTimeInfo

Logged in time of a user.

string
ReadOnly

Indicates whether user has only readonly access.

boolean
OverrideLockedSavings

Indicates whether user can override the locked savings product.

boolean
AllowAMLOverride

Indicates whether user can override AntiMoneyLaundering.

boolean
AllowDormancyOverride

Indicates whether user can override dormant accounts.

boolean
AllowFrozenOverride

Indicates whetehr user can override frozen accounts.

boolean
AllowCashChequeOverride

Indicates whether user can override cash/cheque transactions.

boolean
AllowLivePaymentAccountOverride

Indicates whether user can override live payment accounts.

boolean
CanViewTellerBalances

Indicates whether user can view Teller Balance or not.

boolean
CanEditAllJournals

Indicates whether user can edit journals created by other users.

boolean
CanAccessForeignCurrency

Indicates whether user can perform foreign currency transactions.

boolean
AllowTDGracePeriodCreditOverride

Indicates whether user can override Credit on Term Deposit Grace Period.

boolean
AllowTDGracePeriodDebitOverride

Indicates whether user can override Debit on Term Deposit Grace Period.

boolean
AllowTDAgreedAmountOverride

Indicates whether user can override agreed amount on Term Deposit.

boolean
AllowTellerLimitOverride

Indicates whether user can override Teller limit.

boolean
AllowIssueMoreThanApprovedAmount

Indicates whether user can issue loan more than the approved amount.

boolean
AllowIssueOnExpiredLOC

Indicates whether user can issue loan for Expired Line of Credit application.

boolean
AllowEditSecurityRegister

Indicates whether user can edit security register.

boolean
AllowSavingsWithdrawalOverride

Indicates whether user can override savings withdrawal amount beyond the limit.

boolean
AllowBlockPercentLoanBalanceOverride

Indicates whether user can override the block percent of a loan balance.

boolean
AllowAccountTaxOverride

Indicates whether user can override the account tax .

boolean
AllowOverdraftLimitOverride

Indicates whether user can override the overdraft limit of a account.

boolean
AllowLoanIssueOverride

Indicated whether user can override the loan issue amount.

boolean
CanEditCustomerBiometrics

Indicates whether user has access to edit customer's biometrics data.

boolean
AutoOverrideOfTellerLimit

Indicates whether user has auto override option to override teller limit.

boolean
DifferentGLAccountsForClearance

Different GL accounts to be used for Clearance or not.

boolean
DifferentGLAccountsForDishonour

Different GL accounts to be used for Dishonour or not.

boolean
PasswordChangeDate

Date on which the password was changed.

date
UserProfileID

Unique Identifier of User's Profile.

integer
CanAccessLoanApplicationEdit

Access to edit loan application.

boolean
CanAccessLoanManager

Has access to Loan manager or not.

boolean
LanguageID

Unique Identifier of Language.

integer
CultureInfo

Culture Information.

CultureInfo
UseLastSearch

Indicates whether to use last search info or not.

boolean
CanDeleteLetters

Indicates whether user can delete letter.

boolean
CanEditReceiptNotes

Indicates whether user can edit Receipt notes.

boolean
CanChangeExchangeRate

Indicates whether user can change foreign exchange rate.

boolean
CanUseMidRate

Indicates whether user can use Mid Rate.

boolean
CanChangeCommission

Indicates whether user can change commission rate.

boolean
IsLocked

Indicates whether user is locked or not.

boolean
SupervisorUserId

Unique Identifier of User's Supervisor.

integer
LateRepaymentAuthorizerID

Unique Identifier of Late Repayment Transaction Authorized user.

integer
ShowSignatureOnLoanAgreement

Indicates whether to display User's signature in Loan Agreement.

boolean
AllowUDFWriteAccess

Indicates whether user can add/edit access to user defined fields.

boolean
UDFAuthorizationType

Authorization level for user defined fields.

UDFAuthorizationTypes
CanChangeBlacklistStatus

Indicates whether user can change the status of blacklisted custoemr.

boolean
CanSaveLoanApplication

Indicates whether user has access to save loan application.

boolean
Expired

Indicates whether user is active or expired.

boolean
UserAccessType

Access level of users.

UserAccessTypes
AccessAnyBranch

User's Access level on other branches.

boolean
AllowTellerBalanceToNegative

Indicates whether user's teller account balance can be negative.

boolean
AllowedTransactionTypes

User's access level to transactions.

integer
IgnoreCustomCulture

Indicates whether to ignore user's culture information.

boolean
AllowToPost

User's access to Post transactions.

boolean
AssignPortfolioAutomatically

Indicates whether to assign user's portfolio automatically to customer.

boolean
AllowAccountLevelBalanceLimits

User's access to account level balance limits.

boolean
AllowOverrideBackDate

Indictes whether user can override the back dated application.

boolean
OverrideCustomerRiskProfile

Indicates whether user has access to override risk profiles.

boolean
OverrideMandatorySavings

Indicates whether user can override Mandatory savings.

boolean
CanOverrideLoanLimits

Indicates whether user can override loanlimits.

boolean
OverrideLoanSourceOfFund

Indicates whether user can override loan source of fund.

boolean
OverrideAllowIssueLessThanApprovedAmount

Indicates whether user can issue loan less than the approved amount.

boolean
OverrideDisbursementafterNthPeriod

Indicates whether user can override the disbursement.

boolean
PortfolioCustomerAccess

Indicates whether user can access customer portfolio.

boolean
CanEditCreditLineDetails

User's access to edit Credit line details.

boolean
AllowedApprovalLimits

User's allowed approval limits.

byte
AllowToEditCustomerDetailsWithActiveLoans

User's access to edit customer details.

boolean
AuthorizedToEditInterestRate

User's access to edit Interest Rate.

byte
CashManagerActions

User's access to actions in cash manager screen.

byte
OverridePayoutFee

User's access to override payout fee.

byte
AllowEditBonusDetails

User's access to edit bonus details.

boolean
CanEditTheIndividualProvisionRates

User's access to edit provision rates.

boolean
LoanAuthorizationXml

Loan Autorization.

string
CustomerDocumentAccess

User's access level to custoemr document.

byte

Response Formats

application/json, text/json

Sample:
{
  "userID": 1,
  "userName": "sample string 1",
  "atm": true,
  "glError": true,
  "loanApprovalGroup": 1,
  "administrator": true,
  "personID": 1,
  "logonAnyBranch": true,
  "notify": true,
  "cuAccountPortfolioID": 1,
  "password": "sample string 2",
  "allowApprove": true,
  "allowInterestOverride": true,
  "allowSavingsInterestOverride": true,
  "passwordLifetime": 1,
  "menuItems": [
    "sample string 1",
    "sample string 2"
  ],
  "allowMenuCustomise": true,
  "startUpSessionInfo": true,
  "startUpCustomerInfo": true,
  "startUpCalendarView": true,
  "loggedInTime": "00:00:00.1234567",
  "loggedInTimeInfo": "sample string 4",
  "readOnly": true,
  "overrideLockedSavings": true,
  "allowAMLOverride": true,
  "allowDormancyOverride": true,
  "allowFrozenOverride": true,
  "allowCashChequeOverride": true,
  "allowLivePaymentAccountOverride": true,
  "canViewTellerBalances": true,
  "canEditAllJournals": true,
  "canAccessForeignCurrency": true,
  "allowTDGracePeriodCreditOverride": true,
  "allowTDGracePeriodDebitOverride": true,
  "allowTDAgreedAmountOverride": true,
  "allowTellerLimitOverride": true,
  "allowIssueMoreThanApprovedAmount": true,
  "allowIssueOnExpiredLOC": true,
  "allowEditSecurityRegister": true,
  "allowSavingsWithdrawalOverride": true,
  "allowBlockPercentLoanBalanceOverride": true,
  "allowAccountTaxOverride": true,
  "allowOverdraftLimitOverride": true,
  "allowLoanIssueOverride": true,
  "canEditCustomerBiometrics": true,
  "autoOverrideOfTellerLimit": true,
  "differentGLAccountsForClearance": true,
  "differentGLAccountsForDishonour": true,
  "passwordChangeDate": "2019-06-04T21:08:39.1038323-04:00",
  "userProfileID": 1,
  "canAccessLoanApplicationEdit": true,
  "canAccessLoanManager": true,
  "languageID": 1,
  "cultureInfo": null,
  "useLastSearch": true,
  "canDeleteLetters": true,
  "canEditReceiptNotes": true,
  "canChangeExchangeRate": true,
  "canUseMidRate": true,
  "canChangeCommission": true,
  "isLocked": true,
  "supervisorUserId": 1,
  "lateRepaymentAuthorizerID": 1,
  "showSignatureOnLoanAgreement": true,
  "allowUDFWriteAccess": true,
  "udfAuthorizationType": 1,
  "canChangeBlacklistStatus": true,
  "canSaveLoanApplication": true,
  "expired": true,
  "userAccessType": 1,
  "accessAnyBranch": true,
  "allowTellerBalanceToNegative": true,
  "allowedTransactionTypes": 1,
  "ignoreCustomCulture": true,
  "allowToPost": true,
  "assignPortfolioAutomatically": true,
  "allowAccountLevelBalanceLimits": true,
  "allowOverrideBackDate": true,
  "overrideCustomerRiskProfile": true,
  "overrideMandatorySavings": true,
  "canOverrideLoanLimits": true,
  "overrideLoanSourceOfFund": true,
  "overrideAllowIssueLessThanApprovedAmount": true,
  "overrideDisbursementafterNthPeriod": true,
  "portfolioCustomerAccess": true,
  "canEditCreditLineDetails": true,
  "allowedApprovalLimits": 64,
  "allowToEditCustomerDetailsWithActiveLoans": true,
  "authorizedToEditInterestRate": 64,
  "cashManagerActions": 64,
  "overridePayoutFee": 64,
  "allowEditBonusDetails": true,
  "canEditTheIndividualProvisionRates": true,
  "loanAuthorizationXml": "sample string 6",
  "customerDocumentAccess": 64
}

application/xml, text/xml

Sample:
<UserSettingsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <ATM>true</ATM>
  <AccessAnyBranch>true</AccessAnyBranch>
  <Administrator>true</Administrator>
  <AllowAMLOverride>true</AllowAMLOverride>
  <AllowAccountLevelBalanceLimits>true</AllowAccountLevelBalanceLimits>
  <AllowAccountTaxOverride>true</AllowAccountTaxOverride>
  <AllowApprove>true</AllowApprove>
  <AllowBlockPercentLoanBalanceOverride>true</AllowBlockPercentLoanBalanceOverride>
  <AllowCashChequeOverride>true</AllowCashChequeOverride>
  <AllowDormancyOverride>true</AllowDormancyOverride>
  <AllowEditBonusDetails>true</AllowEditBonusDetails>
  <AllowEditSecurityRegister>true</AllowEditSecurityRegister>
  <AllowFrozenOverride>true</AllowFrozenOverride>
  <AllowInterestOverride>true</AllowInterestOverride>
  <AllowIssueMoreThanApprovedAmount>true</AllowIssueMoreThanApprovedAmount>
  <AllowIssueOnExpiredLOC>true</AllowIssueOnExpiredLOC>
  <AllowLivePaymentAccountOverride>true</AllowLivePaymentAccountOverride>
  <AllowLoanIssueOverride>true</AllowLoanIssueOverride>
  <AllowMenuCustomise>true</AllowMenuCustomise>
  <AllowOverdraftLimitOverride>true</AllowOverdraftLimitOverride>
  <AllowOverrideBackDate>true</AllowOverrideBackDate>
  <AllowSavingsInterestOverride>true</AllowSavingsInterestOverride>
  <AllowSavingsWithdrawalOverride>true</AllowSavingsWithdrawalOverride>
  <AllowTDAgreedAmountOverride>true</AllowTDAgreedAmountOverride>
  <AllowTDGracePeriodCreditOverride>true</AllowTDGracePeriodCreditOverride>
  <AllowTDGracePeriodDebitOverride>true</AllowTDGracePeriodDebitOverride>
  <AllowTellerBalanceToNegative>true</AllowTellerBalanceToNegative>
  <AllowTellerLimitOverride>true</AllowTellerLimitOverride>
  <AllowToEditCustomerDetailsWithActiveLoans>true</AllowToEditCustomerDetailsWithActiveLoans>
  <AllowToPost>true</AllowToPost>
  <AllowUDFWriteAccess>true</AllowUDFWriteAccess>
  <AllowedApprovalLimits>64</AllowedApprovalLimits>
  <AllowedTransactionTypes>1</AllowedTransactionTypes>
  <AssignPortfolioAutomatically>true</AssignPortfolioAutomatically>
  <AuthorizedToEditInterestRate>64</AuthorizedToEditInterestRate>
  <AutoOverrideOfTellerLimit>true</AutoOverrideOfTellerLimit>
  <CUAccountPortfolioID>1</CUAccountPortfolioID>
  <CanAccessForeignCurrency>true</CanAccessForeignCurrency>
  <CanAccessLoanApplicationEdit>true</CanAccessLoanApplicationEdit>
  <CanAccessLoanManager>true</CanAccessLoanManager>
  <CanChangeBlacklistStatus>true</CanChangeBlacklistStatus>
  <CanChangeCommission>true</CanChangeCommission>
  <CanChangeExchangeRate>true</CanChangeExchangeRate>
  <CanDeleteLetters>true</CanDeleteLetters>
  <CanEditAllJournals>true</CanEditAllJournals>
  <CanEditCreditLineDetails>true</CanEditCreditLineDetails>
  <CanEditCustomerBiometrics>true</CanEditCustomerBiometrics>
  <CanEditReceiptNotes>true</CanEditReceiptNotes>
  <CanEditTheIndividualProvisionRates>true</CanEditTheIndividualProvisionRates>
  <CanOverrideLoanLimits>true</CanOverrideLoanLimits>
  <CanSaveLoanApplication>true</CanSaveLoanApplication>
  <CanUseMidRate>true</CanUseMidRate>
  <CanViewTellerBalances>true</CanViewTellerBalances>
  <CashManagerActions>64</CashManagerActions>
  <CultureInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Globalization" i:nil="true" />
  <CustomerDocumentAccess>64</CustomerDocumentAccess>
  <DifferentGLAccountsForClearance>true</DifferentGLAccountsForClearance>
  <DifferentGLAccountsForDishonour>true</DifferentGLAccountsForDishonour>
  <Expired>true</Expired>
  <GLError>true</GLError>
  <IgnoreCustomCulture>true</IgnoreCustomCulture>
  <IsLocked>true</IsLocked>
  <LanguageID>1</LanguageID>
  <LateRepaymentAuthorizerID>1</LateRepaymentAuthorizerID>
  <LoanApprovalGroup>Level1</LoanApprovalGroup>
  <LoanAuthorizationXml>sample string 6</LoanAuthorizationXml>
  <LoggedInTime>PT0.1234567S</LoggedInTime>
  <LoggedInTimeInfo>sample string 4</LoggedInTimeInfo>
  <LogonAnyBranch>true</LogonAnyBranch>
  <MenuItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </MenuItems>
  <Notify>true</Notify>
  <OverrideAllowIssueLessThanApprovedAmount>true</OverrideAllowIssueLessThanApprovedAmount>
  <OverrideCustomerRiskProfile>true</OverrideCustomerRiskProfile>
  <OverrideDisbursementafterNthPeriod>true</OverrideDisbursementafterNthPeriod>
  <OverrideLoanSourceOfFund>true</OverrideLoanSourceOfFund>
  <OverrideLockedSavings>true</OverrideLockedSavings>
  <OverrideMandatorySavings>true</OverrideMandatorySavings>
  <OverridePayoutFee>64</OverridePayoutFee>
  <Password>sample string 2</Password>
  <PasswordChangeDate>2019-06-04T21:08:39.1038323-04:00</PasswordChangeDate>
  <PasswordLifetime>1</PasswordLifetime>
  <PersonID>1</PersonID>
  <PortfolioCustomerAccess>true</PortfolioCustomerAccess>
  <ReadOnly>true</ReadOnly>
  <ShowSignatureOnLoanAgreement>true</ShowSignatureOnLoanAgreement>
  <StartUpCalendarView>true</StartUpCalendarView>
  <StartUpCustomerInfo>true</StartUpCustomerInfo>
  <StartUpSessionInfo>true</StartUpSessionInfo>
  <SupervisorUserId>1</SupervisorUserId>
  <UDFAuthorizationType>AllowAdd</UDFAuthorizationType>
  <UseLastSearch>true</UseLastSearch>
  <UserAccessType>AccessAll</UserAccessType>
  <UserID>1</UserID>
  <UserName>sample string 1</UserName>
  <UserProfileID>1</UserProfileID>
</UserSettingsDto>