Skip to content
NexumAPI Docs

MbraddressService⁠

Manage member address records.

Operations⁠

getMbrAddressFmHistoryPagedListSelectFields⁠

POST

Retrieves a paged 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
TokenstringoptionalSample data for Token
POST/nexum/{sym}/2022.01/mbraddress/getMbrAddressFmHistoryPagedListSelectFields
POST /nexum/627/2022.01/mbraddress/getMbrAddressFmHistoryPagedListSelectFields 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"
  },
  "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": {}
  }
}

searchMbrAddressFmHistoryPagedSelectFields⁠

POST

Searches member addresses from history with pagination and selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
MbrAddressMbrAddrNumberstringoptional
QuerystringoptionalSample data for Query
Path Parameters
symstringrequired
Sym number
Responses
TokenstringoptionalSample data for Token
POST/nexum/{sym}/2022.01/mbraddress/searchMbrAddressFmHistoryPagedSelectFields
POST /nexum/627/2022.01/mbraddress/searchMbrAddressFmHistoryPagedSelectFields 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"
  },
  "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
    }
  },
  "Query": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

updateMbrAddressByID⁠

POST

Updates a member address by its ID.

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/updateMbrAddressByID
POST /nexum/627/2022.01/mbraddress/updateMbrAddressByID 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",
  "MbrAddressUpdatableFields": {
    "Street": "string",
    "City": "string",
    "State": "string",
    "ZipCode": "0",
    "AddressType": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createMbrAddress⁠

POST

Creates a member address.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  },
  "MbrAddressCreatableFields": {
    "Street": "string",
    "City": "string",
    "State": "string",
    "ZipCode": "0",
    "AddressType": 0
  }
}