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

CollateralType

PreviousCheckOrderDefaultNextCollatrlTrackingType

Last updated 10 months ago

Was this helpful?

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTgetCollateralType
  • POSTgetCollateralTypeSelectFields
  • POSTgetCollateralTypePagedList
  • POSTgetCollateralTypeListSelectFields
  • POSTsearchCollateralTypeSelectFields
  • POSTgetCollateralTypePagedListSelectFields
  • POSTsearchCollateralTypePagedSelectFields
  • POSTupdateCollateralTypeByID

getCollateralType

post
Authorizations
Body
CollateralTypeCollateralTypeintegerRequired

Type of collateral associated with the collateral type.

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

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

Successful operation.

{
  "CollateralType": {
    "CollateralStatus": 1,
    "CollateralType": 1,
    "Description": "text",
    "UserChar": [
      {
        "EntryId": 1,
        "UserChar": "text"
      }
    ]
  }
}

getCollateralTypeSelectFields

post
Authorizations
Body
CollateralTypeCollateralTypeintegerOptional

Type of collateral associated with the collateral type.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CollateralTypeCollateralType": 1,
  "SelectableFields": {
    "IncludeAllCollateralTypeFields": true,
    "CollateralTypeFields": {
      "CollateralStatus": true,
      "CollateralType": true,
      "Description": true,
      "UserChar": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CollateralType": {
    "CollateralStatus": 1,
    "CollateralType": 1,
    "Description": "text",
    "UserChar": [
      {
        "EntryId": 1,
        "UserChar": "text"
      }
    ]
  }
}

getCollateralTypePagedList

post
Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getCollateralTypePagedList 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.

{
  "CollateralType": [
    {
      "CollateralStatus": 1,
      "CollateralType": 1,
      "Description": "text",
      "UserChar": [
        {
          "EntryId": 1,
          "UserChar": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

getCollateralTypeListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCollateralTypeFields": true,
    "CollateralTypeFields": {
      "CollateralStatus": true,
      "CollateralType": true,
      "Description": true,
      "UserChar": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CollateralTypeList": {
    "hasReachedMaximumListSize": true,
    "CollateralType": [
      {
        "CollateralStatus": 1,
        "CollateralType": 1,
        "Description": "text",
        "UserChar": [
          {
            "EntryId": 1,
            "UserChar": "text"
          }
        ]
      }
    ]
  }
}

searchCollateralTypeSelectFields

post

Search collateral type select fields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCollateralTypeFields": true,
    "CollateralTypeFields": {
      "CollateralStatus": true,
      "CollateralType": true,
      "Description": true,
      "UserChar": [
        1
      ]
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CollateralTypeList": {
    "hasReachedMaximumListSize": true,
    "CollateralType": [
      {
        "CollateralStatus": 1,
        "CollateralType": 1,
        "Description": "text",
        "UserChar": [
          {
            "EntryId": 1,
            "UserChar": "text"
          }
        ]
      }
    ]
  }
}

getCollateralTypePagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCollateralTypeFields": true,
    "CollateralTypeFields": {
      "CollateralStatus": true,
      "CollateralType": true,
      "Description": true,
      "UserChar": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CollateralType": [
    {
      "CollateralStatus": 1,
      "CollateralType": 1,
      "Description": "text",
      "UserChar": [
        {
          "EntryId": 1,
          "UserChar": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

searchCollateralTypePagedSelectFields

post

Search collateral type paged select fields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCollateralTypeFields": true,
    "CollateralTypeFields": {
      "CollateralStatus": true,
      "CollateralType": true,
      "Description": true,
      "UserChar": [
        1
      ]
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CollateralType": [
    {
      "CollateralStatus": 1,
      "CollateralType": 1,
      "Description": "text",
      "UserChar": [
        {
          "EntryId": 1,
          "UserChar": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

updateCollateralTypeByID

post

Update Collateral Type by ID

Authorizations
Body
CollateralTypeCollateralTypeintegerOptional

Type of collateral associated with the collateral type.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CollateralTypeCollateralType": 1,
  "CollateralTypeUpdatableFields": {
    "CollateralStatus": 1,
    "Description": "text",
    "UserChar": [
      {
        "EntryId": 1,
        "UserChar": "text"
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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