MbraddressService

Manage member address records.

Symitar eDocs References: Coming soon.

Operations

getMbrAddressSelectFields

post

Retrieves a member address with selected fields.

Authorizations

Body

MbrAddressMbrAddrNumberstringOptional

Responses

200

Successful operation.

application/json

post

/getMbrAddressSelectFields

POST /nexum/627/persistent/mbraddress/getMbrAddressSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 588

{
  "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
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "MbrAddress": {
    "AddrCreateDate": "2025-11-07",
    "AddrDisconnectDate": "2025-11-07",
    "AddrExpDate": "2025-11-07",
    "AddrFmLastDate": "2025-11-07",
    "AddrFmLastPurgeDate": "2025-11-07",
    "AddrRecordChangeDate": "2025-11-07",
    "AddressType": 1,
    "CarrierRoute": "text",
    "City": "text",
    "Country": "text",
    "CountryCode": "text",
    "ExtraAddress": "text",
    "Headquarters": 1,
    "MbrAddrFileType": 1,
    "MbrAddrNumber": "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-11-07",
          "NewCharacter": "text",
          "NewDate": "2025-11-07",
          "NewMoney": 1,
          "NewNumber": 1,
          "NewRate": 1,
          "OldCharacter": "text",
          "OldDate": "2025-11-07",
          "OldMoney": 1,
          "OldNumber": 1,
          "OldRate": 1,
          "PostDate": "2025-11-07",
          "PostTime": 1,
          "ProcessorUser": 1,
          "RecordName": "text",
          "RecordType": 1,
          "SecurityLevels": 1,
          "SequenceNumber": 1,
          "SubFieldNumber": 1,
          "UserNumber": 1,
          "UserOverride": 1
        }
      ]
    },
    "State": "text",
    "Street": "text",
    "ZipCode": "text"
  }
}

getMbrAddressSelectFieldsFilterChildren

post

Retrieves a member address with selected fields and filtered children.

Authorizations

Body

MbrAddressMbrAddrNumberstringOptional

Responses

200

Successful operation.

application/json

post

/getMbrAddressSelectFieldsFilterChildren

POST /nexum/627/persistent/mbraddress/getMbrAddressSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1420

{
  "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": {
      "StartPostDate": "2025-11-07",
      "EndPostDate": "2025-11-07",
      "Query": "text"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "MbrAddress": {
    "AddrCreateDate": "2025-11-07",
    "AddrDisconnectDate": "2025-11-07",
    "AddrExpDate": "2025-11-07",
    "AddrFmLastDate": "2025-11-07",
    "AddrFmLastPurgeDate": "2025-11-07",
    "AddrRecordChangeDate": "2025-11-07",
    "AddressType": 1,
    "CarrierRoute": "text",
    "City": "text",
    "Country": "text",
    "CountryCode": "text",
    "ExtraAddress": "text",
    "Headquarters": 1,
    "MbrAddrFileType": 1,
    "MbrAddrNumber": "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-11-07",
          "NewCharacter": "text",
          "NewDate": "2025-11-07",
          "NewMoney": 1,
          "NewNumber": 1,
          "NewRate": 1,
          "OldCharacter": "text",
          "OldDate": "2025-11-07",
          "OldMoney": 1,
          "OldNumber": 1,
          "OldRate": 1,
          "PostDate": "2025-11-07",
          "PostTime": 1,
          "ProcessorUser": 1,
          "RecordName": "text",
          "RecordType": 1,
          "SecurityLevels": 1,
          "SequenceNumber": 1,
          "SubFieldNumber": 1,
          "UserNumber": 1,
          "UserOverride": 1
        }
      ]
    },
    "State": "text",
    "Street": "text",
    "ZipCode": "text"
  }
}

getMbrAddressFmHistoryPagedListSelectFields

post

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

Authorizations

Body

MbrAddressMbrAddrNumberstringOptional

Responses

200

Successful operation.

application/json

post

/getMbrAddressFmHistoryPagedListSelectFields

POST /nexum/627/persistent/mbraddress/getMbrAddressFmHistoryPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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-11-07",
      "NewCharacter": "text",
      "NewDate": "2025-11-07",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2025-11-07",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2025-11-07",
      "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

Responses

200

Successful operation.

application/json

post

/searchMbrAddressFmHistoryPagedSelectFields

POST /nexum/627/persistent/mbraddress/searchMbrAddressFmHistoryPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1026

{
  "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
    }
  },
  "SearchFilter": {
    "StartPostDate": "2025-11-07",
    "EndPostDate": "2025-11-07",
    "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-11-07",
      "NewCharacter": "text",
      "NewDate": "2025-11-07",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2025-11-07",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2025-11-07",
      "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

/updateMbrAddressByID

POST /nexum/627/persistent/mbraddress/updateMbrAddressByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 590

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressMbrAddrNumber": "text",
  "MbrAddressFields": {
    "AddrCreateDate": "2025-11-07",
    "AddrDisconnectDate": "2025-11-07",
    "AddrExpDate": "2025-11-07",
    "AddrFmLastDate": "2025-11-07",
    "AddrFmLastPurgeDate": "2025-11-07",
    "AddrRecordChangeDate": "2025-11-07",
    "AddressType": 1,
    "CarrierRoute": "text",
    "City": "text",
    "Country": "text",
    "CountryCode": "text",
    "ExtraAddress": "text",
    "Headquarters": 1,
    "MbrAddrFileType": 1,
    "MbrAddrNumber": "text",
    "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

/createMbrAddress

POST /nexum/627/persistent/mbraddress/createMbrAddress HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 557

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MbrAddressFields": {
    "AddrCreateDate": "2025-11-07",
    "AddrDisconnectDate": "2025-11-07",
    "AddrExpDate": "2025-11-07",
    "AddrFmLastDate": "2025-11-07",
    "AddrFmLastPurgeDate": "2025-11-07",
    "AddrRecordChangeDate": "2025-11-07",
    "AddressType": 1,
    "CarrierRoute": "text",
    "City": "text",
    "Country": "text",
    "CountryCode": "text",
    "ExtraAddress": "text",
    "Headquarters": 1,
    "MbrAddrFileType": 1,
    "MbrAddrNumber": "text",
    "State": "text",
    "Street": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "MbrAddressMbrAddrNumber": "text"
}

PreviousInventoryService NextMemberService

Last updated 1 year ago

Was this helpful?