Skip to content
NexumAPI Docs

MbraddressService⁠

Manage member address records.

Operations⁠

getMbrAddress⁠

POST

Retrieves a member address.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
MbrAddressMbrAddrNumberstringrequired
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/mbraddress/getMbrAddress
POST /nexum/627/2022.01/mbraddress/getMbrAddress HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

getMbrAddressSelectFields⁠

POST

Retrieves a member address with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
MbrAddressMbrAddrNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/mbraddress/getMbrAddressSelectFields
POST /nexum/627/2022.01/mbraddress/getMbrAddressSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "0",
  "SelectableFields": {
    "IncludeAllMbrAddressFields": false,
    "MbrAddressFields": {
      "MbrAddrNumber": true,
      "Street": true,
      "City": true,
      "State": true,
      "ZipCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getMbrAddressSelectFieldsFilterChildren⁠

POST

Retrieves a member address with selected fields and filtered children.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
MbrAddressMbrAddrNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/mbraddress/getMbrAddressSelectFieldsFilterChildren
POST /nexum/627/2022.01/mbraddress/getMbrAddressSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "string",
  "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
      }
    }
  },
  "ChildrenSearchFilter": {
    "MbrAddressFmHistoryFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getMbrAddressFmHistoryPagedList⁠

POST

Retrieves a paged list of member addresses from history.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
MbrAddressMbrAddrNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
TokenstringoptionalSample data for Token
POST/nexum/{sym}/2022.01/mbraddress/getMbrAddressFmHistoryPagedList
POST /nexum/627/2022.01/mbraddress/getMbrAddressFmHistoryPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getMbrAddressFmHistoryListSelectFields⁠

POST

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

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
MbrAddressMbrAddrNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/mbraddress/getMbrAddressFmHistoryListSelectFields
POST /nexum/627/2022.01/mbraddress/getMbrAddressFmHistoryListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "string",
  "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchMbrAddressFmHistorySelectFields⁠

POST

Searches member addresses from history with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
MbrAddressMbrAddrNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/mbraddress/searchMbrAddressFmHistorySelectFields
POST /nexum/627/2022.01/mbraddress/searchMbrAddressFmHistorySelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "string",
  "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
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}