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

MbraddressService

PreviousInventoryServiceNextMemberService

Last updated 10 months ago

Was this helpful?

Manage member address records.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTgetMbrAddress
  • POSTgetMbrAddressSelectFields
  • POSTgetMbrAddressSelectFieldsFilterChildren
  • POSTgetMbrAddressFmHistoryPagedList
  • POSTgetMbrAddressFmHistoryListSelectFields
  • POSTsearchMbrAddressFmHistorySelectFields
  • POSTgetMbrAddressFmHistoryPagedListSelectFields
  • POSTsearchMbrAddressFmHistoryPagedSelectFields
  • POSTupdateMbrAddressByID
  • POSTcreateMbrAddress

getMbrAddress

post

Retrieves a member address.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "MbrAddress": {
    "AddrCreateDate": "2025-05-21",
    "AddrDisconnectDate": "2025-05-21",
    "AddrExpDate": "2025-05-21",
    "AddrFmLastDate": "2025-05-21",
    "AddrFmLastPurgeDate": "2025-05-21",
    "AddrRecordChangeDate": "2025-05-21",
    "AddressType": 1,
    "CarrierRoute": "text",
    "City": "text",
    "Country": "text",
    "CountryCode": "text",
    "ExtraAddress": "text",
    "MbrAddrFileType": 1,
    "MbrAddrNumber": "text",
    "State": "text",
    "Street": "text",
    "ZipCode": "text",
    "MbrAddressFmHistoryList": {
      "hasReachedMaximumListSize": true,
      "MbrAddressFmHistory": [
        {
          "AccountNumber": "text",
          "BatchSequence": 1,
          "Branch": 1,
          "ConfirmationNumber": "text",
          "ConfirmationSeq": 1,
          "ConsoleNumber": 1,
          "DataType": 1,
          "FieldName": "text",
          "FieldNumber": 1,
          "FmType": 1,
          "Id": "text",
          "IdType": 1,
          "LastFmDate": "2025-05-21",
          "NewCharacter": "text",
          "NewDate": "2025-05-21",
          "NewMoney": 1,
          "NewNumber": 1,
          "NewRate": 1,
          "OldCharacter": "text",
          "OldDate": "2025-05-21",
          "OldMoney": 1,
          "OldNumber": 1,
          "OldRate": 1,
          "PostDate": "2025-05-21",
          "PostTime": 1,
          "ProcessorUser": 1,
          "RecordName": "text",
          "RecordType": 1,
          "SecurityLevels": 1,
          "SequenceNumber": 1,
          "SubFieldNumber": 1,
          "UserNumber": 1,
          "UserOverride": 1
        }
      ]
    },
    "Headquarters": 1
  }
}

getMbrAddressSelectFields

post

Retrieves a member address with selected fields.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "text",
  "SelectableFields": {
    "IncludeAllMbrAddressFields": true,
    "MbrAddressFields": {
      "AddrCreateDate": true,
      "AddrDisconnectDate": true,
      "AddrExpDate": true,
      "AddrFmLastDate": true,
      "AddrFmLastPurgeDate": true,
      "AddrRecordChangeDate": true,
      "AddressType": true,
      "CarrierRoute": true,
      "City": true,
      "Country": true,
      "CountryCode": true,
      "ExtraAddress": true,
      "Headquarters": true,
      "MbrAddrFileType": true,
      "MbrAddrNumber": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    },
    "MbrAddressFmHistorySelectableFields": {
      "IncludeAllMbrAddressFmHistoryFields": true,
      "MbrAddressFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": true,
        "ConfirmationNumber": true,
        "ConfirmationSeq": true,
        "ConsoleNumber": true,
        "DataType": true,
        "FieldName": true,
        "FieldNumber": true,
        "FmType": true,
        "Id": true,
        "IdType": true,
        "LastFmDate": true,
        "NewCharacter": true,
        "NewDate": true,
        "NewMoney": true,
        "NewNumber": true,
        "NewRate": true,
        "OldCharacter": true,
        "OldDate": true,
        "OldMoney": true,
        "OldNumber": true,
        "OldRate": true,
        "PostDate": true,
        "PostTime": true,
        "ProcessorUser": true,
        "RecordName": true,
        "RecordType": true,
        "SecurityLevels": true,
        "SequenceNumber": true,
        "SubFieldNumber": true,
        "UserNumber": true,
        "UserOverride": true
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "MbrAddress": {
    "AddrCreateDate": "2025-05-21",
    "AddrDisconnectDate": "2025-05-21",
    "AddrExpDate": "2025-05-21",
    "AddrFmLastDate": "2025-05-21",
    "AddrFmLastPurgeDate": "2025-05-21",
    "AddrRecordChangeDate": "2025-05-21",
    "AddressType": 1,
    "CarrierRoute": "text",
    "City": "text",
    "Country": "text",
    "CountryCode": "text",
    "ExtraAddress": "text",
    "MbrAddrFileType": 1,
    "MbrAddrNumber": "text",
    "State": "text",
    "Street": "text",
    "ZipCode": "text",
    "MbrAddressFmHistoryList": {
      "hasReachedMaximumListSize": true,
      "MbrAddressFmHistory": [
        {
          "AccountNumber": "text",
          "BatchSequence": 1,
          "Branch": 1,
          "ConfirmationNumber": "text",
          "ConfirmationSeq": 1,
          "ConsoleNumber": 1,
          "DataType": 1,
          "FieldName": "text",
          "FieldNumber": 1,
          "FmType": 1,
          "Id": "text",
          "IdType": 1,
          "LastFmDate": "2025-05-21",
          "NewCharacter": "text",
          "NewDate": "2025-05-21",
          "NewMoney": 1,
          "NewNumber": 1,
          "NewRate": 1,
          "OldCharacter": "text",
          "OldDate": "2025-05-21",
          "OldMoney": 1,
          "OldNumber": 1,
          "OldRate": 1,
          "PostDate": "2025-05-21",
          "PostTime": 1,
          "ProcessorUser": 1,
          "RecordName": "text",
          "RecordType": 1,
          "SecurityLevels": 1,
          "SequenceNumber": 1,
          "SubFieldNumber": 1,
          "UserNumber": 1,
          "UserOverride": 1
        }
      ]
    },
    "Headquarters": 1
  }
}

getMbrAddressSelectFieldsFilterChildren

post

Retrieves a member address with selected fields and filtered children.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "text",
  "SelectableFields": {
    "IncludeAllMbrAddressFields": true,
    "MbrAddressFields": {
      "AddrCreateDate": true,
      "AddrDisconnectDate": true,
      "AddrExpDate": true,
      "AddrFmLastDate": true,
      "AddrFmLastPurgeDate": true,
      "AddrRecordChangeDate": true,
      "AddressType": true,
      "CarrierRoute": true,
      "City": true,
      "Country": true,
      "CountryCode": true,
      "ExtraAddress": true,
      "Headquarters": true,
      "MbrAddrFileType": true,
      "MbrAddrNumber": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    },
    "MbrAddressFmHistorySelectableFields": {
      "IncludeAllMbrAddressFmHistoryFields": true,
      "MbrAddressFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": true,
        "ConfirmationNumber": true,
        "ConfirmationSeq": true,
        "ConsoleNumber": true,
        "DataType": true,
        "FieldName": true,
        "FieldNumber": true,
        "FmType": true,
        "Id": true,
        "IdType": true,
        "LastFmDate": true,
        "NewCharacter": true,
        "NewDate": true,
        "NewMoney": true,
        "NewNumber": true,
        "NewRate": true,
        "OldCharacter": true,
        "OldDate": true,
        "OldMoney": true,
        "OldNumber": true,
        "OldRate": true,
        "PostDate": true,
        "PostTime": true,
        "ProcessorUser": true,
        "RecordName": true,
        "RecordType": true,
        "SecurityLevels": true,
        "SequenceNumber": true,
        "SubFieldNumber": true,
        "UserNumber": true,
        "UserOverride": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "MbrAddressFmHistoryFilter": {
      "Query": "text"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "MbrAddress": {
    "AddrCreateDate": "2025-05-21",
    "AddrDisconnectDate": "2025-05-21",
    "AddrExpDate": "2025-05-21",
    "AddrFmLastDate": "2025-05-21",
    "AddrFmLastPurgeDate": "2025-05-21",
    "AddrRecordChangeDate": "2025-05-21",
    "AddressType": 1,
    "CarrierRoute": "text",
    "City": "text",
    "Country": "text",
    "CountryCode": "text",
    "ExtraAddress": "text",
    "MbrAddrFileType": 1,
    "MbrAddrNumber": "text",
    "State": "text",
    "Street": "text",
    "ZipCode": "text",
    "MbrAddressFmHistoryList": {
      "hasReachedMaximumListSize": true,
      "MbrAddressFmHistory": [
        {
          "AccountNumber": "text",
          "BatchSequence": 1,
          "Branch": 1,
          "ConfirmationNumber": "text",
          "ConfirmationSeq": 1,
          "ConsoleNumber": 1,
          "DataType": 1,
          "FieldName": "text",
          "FieldNumber": 1,
          "FmType": 1,
          "Id": "text",
          "IdType": 1,
          "LastFmDate": "2025-05-21",
          "NewCharacter": "text",
          "NewDate": "2025-05-21",
          "NewMoney": 1,
          "NewNumber": 1,
          "NewRate": 1,
          "OldCharacter": "text",
          "OldDate": "2025-05-21",
          "OldMoney": 1,
          "OldNumber": 1,
          "OldRate": 1,
          "PostDate": "2025-05-21",
          "PostTime": 1,
          "ProcessorUser": 1,
          "RecordName": "text",
          "RecordType": 1,
          "SecurityLevels": 1,
          "SequenceNumber": 1,
          "SubFieldNumber": 1,
          "UserNumber": 1,
          "UserOverride": 1
        }
      ]
    },
    "Headquarters": 1
  }
}

getMbrAddressFmHistoryPagedList

post

Retrieves a paged list of member addresses from history.

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

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

Successful operation.

{
  "MbrAddressFmHistory": [
    {
      "AccountNumber": "text",
      "BatchSequence": 1,
      "Branch": 1,
      "ConfirmationNumber": "text",
      "ConfirmationSeq": 1,
      "ConsoleNumber": 1,
      "DataType": 1,
      "FieldName": "text",
      "FieldNumber": 1,
      "FmType": 1,
      "Id": "text",
      "IdType": 1,
      "LastFmDate": "2025-05-21",
      "NewCharacter": "text",
      "NewDate": "2025-05-21",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2025-05-21",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2025-05-21",
      "PostTime": 1,
      "ProcessorUser": 1,
      "RecordName": "text",
      "RecordType": 1,
      "SecurityLevels": 1,
      "SequenceNumber": 1,
      "SubFieldNumber": 1,
      "UserNumber": 1,
      "UserOverride": 1
    }
  ],
  "Token": "text"
}

getMbrAddressFmHistoryListSelectFields

post

Retrieves a list of member addresses with selected fields from history.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "text",
  "SelectableFields": {
    "IncludeAllMbrAddressFmHistoryFields": true,
    "MbrAddressFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationNumber": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldName": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true,
      "OldNumber": true,
      "OldRate": true,
      "PostDate": true,
      "PostTime": true,
      "ProcessorUser": true,
      "RecordName": true,
      "RecordType": true,
      "SecurityLevels": true,
      "SequenceNumber": true,
      "SubFieldNumber": true,
      "UserNumber": true,
      "UserOverride": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "MbrAddressFmHistoryList": {
    "hasReachedMaximumListSize": true,
    "MbrAddressFmHistory": [
      {
        "AccountNumber": "text",
        "BatchSequence": 1,
        "Branch": 1,
        "ConfirmationNumber": "text",
        "ConfirmationSeq": 1,
        "ConsoleNumber": 1,
        "DataType": 1,
        "FieldName": "text",
        "FieldNumber": 1,
        "FmType": 1,
        "Id": "text",
        "IdType": 1,
        "LastFmDate": "2025-05-21",
        "NewCharacter": "text",
        "NewDate": "2025-05-21",
        "NewMoney": 1,
        "NewNumber": 1,
        "NewRate": 1,
        "OldCharacter": "text",
        "OldDate": "2025-05-21",
        "OldMoney": 1,
        "OldNumber": 1,
        "OldRate": 1,
        "PostDate": "2025-05-21",
        "PostTime": 1,
        "ProcessorUser": 1,
        "RecordName": "text",
        "RecordType": 1,
        "SecurityLevels": 1,
        "SequenceNumber": 1,
        "SubFieldNumber": 1,
        "UserNumber": 1,
        "UserOverride": 1
      }
    ]
  }
}

searchMbrAddressFmHistorySelectFields

post

Searches member addresses from history with selected fields.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "text",
  "SelectableFields": {
    "IncludeAllMbrAddressFmHistoryFields": true,
    "MbrAddressFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationNumber": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldName": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true,
      "OldNumber": true,
      "OldRate": true,
      "PostDate": true,
      "PostTime": true,
      "ProcessorUser": true,
      "RecordName": true,
      "RecordType": true,
      "SecurityLevels": true,
      "SequenceNumber": true,
      "SubFieldNumber": true,
      "UserNumber": true,
      "UserOverride": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "MbrAddressFmHistoryList": {
    "hasReachedMaximumListSize": true,
    "MbrAddressFmHistory": [
      {
        "AccountNumber": "text",
        "BatchSequence": 1,
        "Branch": 1,
        "ConfirmationNumber": "text",
        "ConfirmationSeq": 1,
        "ConsoleNumber": 1,
        "DataType": 1,
        "FieldName": "text",
        "FieldNumber": 1,
        "FmType": 1,
        "Id": "text",
        "IdType": 1,
        "LastFmDate": "2025-05-21",
        "NewCharacter": "text",
        "NewDate": "2025-05-21",
        "NewMoney": 1,
        "NewNumber": 1,
        "NewRate": 1,
        "OldCharacter": "text",
        "OldDate": "2025-05-21",
        "OldMoney": 1,
        "OldNumber": 1,
        "OldRate": 1,
        "PostDate": "2025-05-21",
        "PostTime": 1,
        "ProcessorUser": 1,
        "RecordName": "text",
        "RecordType": 1,
        "SecurityLevels": 1,
        "SequenceNumber": 1,
        "SubFieldNumber": 1,
        "UserNumber": 1,
        "UserOverride": 1
      }
    ]
  }
}

getMbrAddressFmHistoryPagedListSelectFields

post

Retrieves a paged list of member addresses with selected fields from history.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllMbrAddressFmHistoryFields": true,
    "MbrAddressFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationNumber": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldName": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true,
      "OldNumber": true,
      "OldRate": true,
      "PostDate": true,
      "PostTime": true,
      "ProcessorUser": true,
      "RecordName": true,
      "RecordType": true,
      "SecurityLevels": true,
      "SequenceNumber": true,
      "SubFieldNumber": true,
      "UserNumber": true,
      "UserOverride": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "MbrAddressFmHistory": [
    {
      "AccountNumber": "text",
      "BatchSequence": 1,
      "Branch": 1,
      "ConfirmationNumber": "text",
      "ConfirmationSeq": 1,
      "ConsoleNumber": 1,
      "DataType": 1,
      "FieldName": "text",
      "FieldNumber": 1,
      "FmType": 1,
      "Id": "text",
      "IdType": 1,
      "LastFmDate": "2025-05-21",
      "NewCharacter": "text",
      "NewDate": "2025-05-21",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2025-05-21",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2025-05-21",
      "PostTime": 1,
      "ProcessorUser": 1,
      "RecordName": "text",
      "RecordType": 1,
      "SecurityLevels": 1,
      "SequenceNumber": 1,
      "SubFieldNumber": 1,
      "UserNumber": 1,
      "UserOverride": 1
    }
  ],
  "Token": "text"
}

searchMbrAddressFmHistoryPagedSelectFields

post

Searches member addresses from history with pagination and selected fields.

Authorizations
Body
MbrAddressMbrAddrNumberstringOptional
QuerystringOptional

Sample data for Query

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllMbrAddressFmHistoryFields": true,
    "MbrAddressFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationNumber": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldName": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true,
      "OldNumber": true,
      "OldRate": true,
      "PostDate": true,
      "PostTime": true,
      "ProcessorUser": true,
      "RecordName": true,
      "RecordType": true,
      "SecurityLevels": true,
      "SequenceNumber": true,
      "SubFieldNumber": true,
      "UserNumber": true,
      "UserOverride": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "MbrAddressFmHistory": [
    {
      "AccountNumber": "text",
      "BatchSequence": 1,
      "Branch": 1,
      "ConfirmationNumber": "text",
      "ConfirmationSeq": 1,
      "ConsoleNumber": 1,
      "DataType": 1,
      "FieldName": "text",
      "FieldNumber": 1,
      "FmType": 1,
      "Id": "text",
      "IdType": 1,
      "LastFmDate": "2025-05-21",
      "NewCharacter": "text",
      "NewDate": "2025-05-21",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2025-05-21",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2025-05-21",
      "PostTime": 1,
      "ProcessorUser": 1,
      "RecordName": "text",
      "RecordType": 1,
      "SecurityLevels": 1,
      "SequenceNumber": 1,
      "SubFieldNumber": 1,
      "UserNumber": 1,
      "UserOverride": 1
    }
  ],
  "Token": "text"
}

updateMbrAddressByID

post

Updates a member address by its ID.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "text",
  "MbrAddressUpdatableFields": {
    "AddrExpDate": "2025-05-21",
    "AddressType": 1,
    "CarrierRoute": "text",
    "City": "text",
    "Country": "text",
    "CountryCode": "text",
    "ExtraAddress": "text",
    "Headquarters": 1,
    "State": "text",
    "Street": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

createMbrAddress

post

Creates a member address.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressCreatableFields": {
    "AddrExpDate": "2025-05-21",
    "AddressType": 1,
    "CarrierRoute": "text",
    "City": "text",
    "Country": "text",
    "CountryCode": "text",
    "ExtraAddress": "text",
    "Headquarters": 1,
    "State": "text",
    "Street": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "MbrAddressMbrAddrNumber": "text"
}