NexumAPI Docs
NexumAPI Docs
  • Introduction
  • Authentication
  • Quickstart
  • NaaS Endpoints
  • Capabilities
  • Changelog
  • Links
    • NexumAPI
    • GitHub
  • Resources
    • Symitar Playground
    • Help & Feedback
  • SymXchange
    • API Reference
      • Persistent
        • AccountService
          • Account
          • BatchAchOrig
          • Card
            • createCard
            • deleteCard
            • getCard
            • searchCard
            • updateCard
          • Comment
          • CpWorkCard
          • CredRep
          • Eft
            • createEft
            • deleteEft
            • getEft
            • searchEft
            • updateEft
          • ExternalAccount
          • ExternalLoan
            • createExternalLoan
            • deleteExternalLoan
            • getExternalLoan
            • searchExternalLoan
            • updateExternalLoan
          • FmHistoryPagedList
          • Household
          • Irs
            • createIrs
            • deleteIrs
            • getIrs
            • searchIrs
            • updateIrs
          • Loan
            • createLoan
            • deleteLoan
            • getLoan
            • searchLoan
            • updateLoan
          • LoanApp
            • createLoanApp
            • deleteLoanApp
            • getLoanApp
            • searchLoanApp
            • updateLoanApp
          • Lookup
          • Name
          • Note
          • Pledge
          • Portfolio
            • createPortfolio
            • deletePortfolio
            • getPortfolio
            • searchPortfolio
            • updatePortfolio
          • Preference
          • Share
            • createShare
            • deleteShare
            • getShare
            • searchShare
            • updateShare
          • Site
          • Tracking
        • AccountsPayableService
        • BalancingService
        • BatchJobsService
        • CashLetterService
        • CheckService
        • CheckVerificationService
        • CollateralService
        • ContactEventMgmtService
        • CorpTransferService
        • CreditReportService
        • DealerService
        • EcaaService
        • ExceptionItemService
        • FileManagementService
        • FindByService
        • FinrepService
        • GeneralLedgerService
        • InformationService
        • InventoryService
        • MbraddressService
        • MemberService
        • NonAccountNameService
        • ParticipantService
        • PayeeService
        • PowerOnService
        • ProjectionService
        • ReceivedItemService
        • RemittanceService
        • TransactionsService
        • UserManagementService
        • UserService
        • WireService
          • Wire
          • WireBeneficiary
            • createWireBeneficiary
            • deleteWireBeneficiary
            • getWireBeneficiary
            • searchWireBeneficiary
            • updateWireBeneficiary
          • WireDrawdownDebit
          • WireFiToFiInfo
          • WireFmHistory
          • WireIntermedFi
          • WireOfacDetails
          • WireReceiverFiInfo
          • WireServiceMessage
          • WireUscAudit
      • v2022.01
        • AccountService
          • Account
          • BatchAchOrig
          • Card
            • createCard
            • deleteCard
            • getCard
            • searchCard
            • updateCard
          • Comment
          • CpWorkCard
          • CredRep
          • Eft
            • createEft
            • deleteEft
            • getEft
            • searchEft
            • updateEft
          • ExternalAccount
          • ExternalLoan
            • createExternalLoan
            • deleteExternalLoan
            • getExternalLoan
            • searchExternalLoan
            • updateExternalLoan
          • FmHistoryPagedList
          • Household
          • Irs
            • createIrs
            • deleteIrs
            • getIrs
            • searchIrs
            • updateIrs
          • Loan
            • createLoan
            • deleteLoan
            • getLoan
            • searchLoan
            • updateLoan
          • LoanApp
            • createLoanApp
            • deleteLoanApp
            • getLoanApp
            • searchLoanApp
            • updateLoanApp
          • Lookup
          • Name
          • Note
          • Pledge
          • Portfolio
            • createPortfolio
            • deletePortfolio
            • getPortfolio
            • searchPortfolio
            • updatePortfolio
          • Preference
          • Share
            • createShare
            • deleteShare
            • getShare
            • searchShare
            • updateShare
          • Site
          • Tracking
        • AccountsPayableService
        • BalancingService
        • BatchJobsService
        • CashLetterService
        • CashMachines
        • CheckService
        • CheckVerificationService
        • CollateralService
        • ContactEventMgmtService
        • CorpTransferService
        • CreditReportService
        • DealerService
        • EcaaService
        • EpisysInformationService
        • ExceptionItemService
        • FileManagementService
        • FindByService
        • FinrepService
        • GeneralLedgerService
        • InventoryService
        • MbraddressService
        • MemberService
        • NonAccountNameService
        • ParameterService
          • AccountDefault
          • AccountFieldName
          • AcctLimit
          • AcctMembGrpDesc
          • AcctRelCodeDesc
          • AcctTrackingType
          • AcctTypeName
          • AcsGlobal
          • AcsService
          • ActivityFm
          • AnalysisFloat
          • AnalysisGlobal
          • AnalysisPlan
          • ApPmtTermsTablePagedList
          • ApWorkFlow
          • Atm
          • Audio
          • BatchRc
          • CardDefault
          • CardWiz
          • CashOrderVendor
          • Cdm
          • CheckOrderDefault
          • CollateralType
          • CollatrlTrackingType
          • Comment
          • ConsoleFm
          • CorpTransfer
          • CpLetter
          • CpWorkCard
          • CreditReport
          • Crs
          • CurrencyCtrl
          • DailyPost
          • DealerStatement
          • DebtRatio
          • Disclosure
          • DivIndexGlobal
          • DivIndexLocal
          • DivTable
          • DocExcpNotice
          • DocTypeDefault
          • DocumentNumber
          • EpisysDbExtract
          • EscrowAnalysis
          • EscrowType
          • ExtLoan
          • GlCategory
          • GlCode
          • GlTable
          • GlTrackingType
          • GlxLate
          • IdentIdTypeDesc
          • Imaging
          • InqDefinition
          • InsTable
          • InsType
          • Institution
          • IntIndex
          • IntType
          • InventoryCopiedFlds
          • InventoryDefault
          • InventoryFieldName
          • InventoryType
          • IrsBkupWithhold
          • IrsContriLimit
          • ItcFraud
          • ItcInstallation
          • LateChg
          • LnSegmentDefault
          • LoanAppCopiedFlds
          • LoanAppDefault
          • LoanAppDenial
          • LoanAppFieldName
          • LoanAppFormPkt
          • LoanAppMisc
          • LoanAppPrintApp
          • LoanAppReusedFlds
          • LoanAppVerForm
          • LoanAppViewApp
          • LoanAppWorkFlow
          • LoanDefault
          • LoanFieldName
          • LoanTypeIdRange
          • LookupTypeName
          • Misc
          • MoProduct
          • NameFieldName
          • Ncua5300
          • NonRegCc
          • Notice
          • OnlineBlock
          • OnlineCard
          • OnlineFee
          • OnlineFile
          • OnlineMain
          • OnlineNet
          • OnlineOutlet
          • OnlineSbAddOn
          • OnlineSba
          • OnlineSbi
          • Param360View
          • Parameter
          • PartStatement
          • PartTrackingType
          • ParticipantFieldName
          • PayCalc
          • PeriodicMtg
          • PlanDefault
          • PlanFieldName
          • PmtAppMethod
          • PositivePay
          • PreferenceDefault
          • PrivGroup
          • RegCc
          • ScreenDefinition
          • SecField
          • Security
          • ShareDefault
          • ShareFieldName
          • Statement
          • StmtMailName
          • StmtMessages
          • Stock
          • SycClient
          • SycGeneral
          • SymXClient
          • SymXDeviceMap
          • SymXGeneral
          • SymXInstance
          • SynapsysMrm
          • TcProduct
          • TellerFee
          • TellerTranFee
          • TellerTranValidate
          • Tpt
          • TrackingCode
          • UserFm
          • UserTrackingFm
          • UserTrackingType
          • Warnings
          • WdFee
          • WestUnCommCode
          • WireBfc
          • WireCorpVer
          • WireIdCode
          • WireInCmtCode
          • WireMisc
          • WireOutCmtCode
          • WireTypeCode
          • WorkFlowRepGen
          • YellowHammer
        • ParticipantService
        • PayeeService
        • PowerOnService
        • ProjectionService
        • ReceivedItemService
        • RemittanceService
        • SymXchangeVerificationService
        • TransactionsService
        • UserManagementService
        • UserService
        • WireService
          • Wire
          • WireBeneficiary
            • createWireBeneficiary
            • deleteWireBeneficiary
            • getWireBeneficiary
            • searchWireBeneficiary
            • updateWireBeneficiary
          • WireDrawdownDebit
          • WireFiToFiInfo
          • WireFmHistory
          • WireIntermedFi
          • WireOfacDetails
          • WireReceiverFiInfo
          • WireServiceMessage
          • WireUscAudit
    • Credentials
    • Device Information
Powered by GitBook
On this page

Was this helpful?

  1. SymXchange
  2. API Reference
  3. v2022.01
  4. ParameterService

InsType

PreviousInsTableNextInstitution

Last updated 10 months ago

Was this helpful?

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTgetInsType
  • POSTgetInsTypeSelectFields
  • POSTgetInsTypePagedList
  • POSTgetInsTypeListSelectFields
  • POSTsearchInsTypeSelectFields
  • POSTgetInsTypePagedListSelectFields
  • POSTsearchInsTypePagedSelectFields
  • POSTupdateInsTypeByID

getInsType

post

Get the getInsType data.

Authorizations
Body
InsTypeInsuranceTypeintegerRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getInsType HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InsTypeInsuranceType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InsType": {
    "ConsolidationCode": 1,
    "DefinedCode": 1,
    "DisabilityInsuranceTable": 1,
    "LifeInsuranceTable": 1,
    "LongDescription": "text",
    "MaxDisDirectInsType": 1,
    "MaxLifeDirectInsType": 1,
    "SecondInsuredAsPrimeDis": true,
    "SecondInsuredAsPrimeLife": true,
    "ShortDescription": "text",
    "InsuranceType": 1
  }
}

getInsTypeSelectFields

post

Get the getInsTypeSelectFields data.

Authorizations
Body
InsTypeInsuranceTypeintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getInsTypeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 507

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InsTypeInsuranceType": 1,
  "SelectableFields": {
    "IncludeAllInsTypeFields": true,
    "InsTypeFields": {
      "ConsolidationCode": true,
      "DefinedCode": true,
      "DisabilityInsuranceTable": true,
      "InsuranceType": true,
      "LifeInsuranceTable": true,
      "LongDescription": true,
      "MaxDisDirectInsType": true,
      "MaxLifeDirectInsType": true,
      "SecondInsuredAsPrimeDis": true,
      "SecondInsuredAsPrimeLife": true,
      "ShortDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InsType": {
    "ConsolidationCode": 1,
    "DefinedCode": 1,
    "DisabilityInsuranceTable": 1,
    "LifeInsuranceTable": 1,
    "LongDescription": "text",
    "MaxDisDirectInsType": 1,
    "MaxLifeDirectInsType": 1,
    "SecondInsuredAsPrimeDis": true,
    "SecondInsuredAsPrimeLife": true,
    "ShortDescription": "text",
    "InsuranceType": 1
  }
}

getInsTypePagedList

post

Get the getInsTypePagedList data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getInsTypePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InsType": [
    {
      "ConsolidationCode": 1,
      "DefinedCode": 1,
      "DisabilityInsuranceTable": 1,
      "LifeInsuranceTable": 1,
      "LongDescription": "text",
      "MaxDisDirectInsType": 1,
      "MaxLifeDirectInsType": 1,
      "SecondInsuredAsPrimeDis": true,
      "SecondInsuredAsPrimeLife": true,
      "ShortDescription": "text",
      "InsuranceType": 1
    }
  ],
  "Token": "text"
}

getInsTypeListSelectFields

post

Get the getInsTypeListSelectFields data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getInsTypeListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 482

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllInsTypeFields": true,
    "InsTypeFields": {
      "ConsolidationCode": true,
      "DefinedCode": true,
      "DisabilityInsuranceTable": true,
      "InsuranceType": true,
      "LifeInsuranceTable": true,
      "LongDescription": true,
      "MaxDisDirectInsType": true,
      "MaxLifeDirectInsType": true,
      "SecondInsuredAsPrimeDis": true,
      "SecondInsuredAsPrimeLife": true,
      "ShortDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InsTypeList": {
    "hasReachedMaximumListSize": true,
    "InsType": [
      {
        "ConsolidationCode": 1,
        "DefinedCode": 1,
        "DisabilityInsuranceTable": 1,
        "LifeInsuranceTable": 1,
        "LongDescription": "text",
        "MaxDisDirectInsType": 1,
        "MaxLifeDirectInsType": 1,
        "SecondInsuredAsPrimeDis": true,
        "SecondInsuredAsPrimeLife": true,
        "ShortDescription": "text",
        "InsuranceType": 1
      }
    ]
  }
}

searchInsTypeSelectFields

post

Field for selecting various options related to searchinstypeselectfields

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchInsTypeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 514

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllInsTypeFields": true,
    "InsTypeFields": {
      "ConsolidationCode": true,
      "DefinedCode": true,
      "DisabilityInsuranceTable": true,
      "InsuranceType": true,
      "LifeInsuranceTable": true,
      "LongDescription": true,
      "MaxDisDirectInsType": true,
      "MaxLifeDirectInsType": true,
      "SecondInsuredAsPrimeDis": true,
      "SecondInsuredAsPrimeLife": true,
      "ShortDescription": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InsTypeList": {
    "hasReachedMaximumListSize": true,
    "InsType": [
      {
        "ConsolidationCode": 1,
        "DefinedCode": 1,
        "DisabilityInsuranceTable": 1,
        "LifeInsuranceTable": 1,
        "LongDescription": "text",
        "MaxDisDirectInsType": 1,
        "MaxLifeDirectInsType": 1,
        "SecondInsuredAsPrimeDis": true,
        "SecondInsuredAsPrimeLife": true,
        "ShortDescription": "text",
        "InsuranceType": 1
      }
    ]
  }
}

getInsTypePagedListSelectFields

post

Get the getInsTypePagedListSelectFields data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getInsTypePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 576

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllInsTypeFields": true,
    "InsTypeFields": {
      "ConsolidationCode": true,
      "DefinedCode": true,
      "DisabilityInsuranceTable": true,
      "InsuranceType": true,
      "LifeInsuranceTable": true,
      "LongDescription": true,
      "MaxDisDirectInsType": true,
      "MaxLifeDirectInsType": true,
      "SecondInsuredAsPrimeDis": true,
      "SecondInsuredAsPrimeLife": true,
      "ShortDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InsType": [
    {
      "ConsolidationCode": 1,
      "DefinedCode": 1,
      "DisabilityInsuranceTable": 1,
      "LifeInsuranceTable": 1,
      "LongDescription": "text",
      "MaxDisDirectInsType": 1,
      "MaxLifeDirectInsType": 1,
      "SecondInsuredAsPrimeDis": true,
      "SecondInsuredAsPrimeLife": true,
      "ShortDescription": "text",
      "InsuranceType": 1
    }
  ],
  "Token": "text"
}

searchInsTypePagedSelectFields

post

Field for selecting various options related to searchinstypepagedselectfields

Authorizations
Body
QuerystringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchInsTypePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 591

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllInsTypeFields": true,
    "InsTypeFields": {
      "ConsolidationCode": true,
      "DefinedCode": true,
      "DisabilityInsuranceTable": true,
      "InsuranceType": true,
      "LifeInsuranceTable": true,
      "LongDescription": true,
      "MaxDisDirectInsType": true,
      "MaxLifeDirectInsType": true,
      "SecondInsuredAsPrimeDis": true,
      "SecondInsuredAsPrimeLife": true,
      "ShortDescription": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InsType": [
    {
      "ConsolidationCode": 1,
      "DefinedCode": 1,
      "DisabilityInsuranceTable": 1,
      "LifeInsuranceTable": 1,
      "LongDescription": "text",
      "MaxDisDirectInsType": 1,
      "MaxLifeDirectInsType": 1,
      "SecondInsuredAsPrimeDis": true,
      "SecondInsuredAsPrimeLife": true,
      "ShortDescription": "text",
      "InsuranceType": 1
    }
  ],
  "Token": "text"
}

updateInsTypeByID

post
Authorizations
Body
InsTypeInsuranceTypeintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/updateInsTypeByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InsTypeInsuranceType": 1,
  "InsTypeUpdatableFields": {
    "ConsolidationCode": 1,
    "DefinedCode": 1,
    "DisabilityInsuranceTable": 1,
    "LifeInsuranceTable": 1,
    "LongDescription": "text",
    "MaxDisDirectInsType": 1,
    "MaxLifeDirectInsType": 1,
    "SecondInsuredAsPrimeDis": true,
    "SecondInsuredAsPrimeLife": true,
    "ShortDescription": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}