For the complete documentation index, see llms.txt. This page is also available as Markdown.

MemberService

Manage member records.

Symitar eDocs References: Coming soon.

Operations

getMemberRecSelectFields

post

Retrieves a member record with selected fields. Description.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
MemberRecMemberNumberstringOptional
Responses
200

Successful operation.

application/json
post/getMemberRecSelectFields
POST /nexum/627/persistent/member/getMemberRecSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 333

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MemberRecMemberNumber": "20080920000007924",
  "SelectableFields": {
    "IncludeAllMemberRecFields": false,
    "MemberRecFields": {
      "MemberNumber": true,
      "First": true,
      "Last": true,
      "BirthDate": true,
      "MbrStatus": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "MemberRec": {
    "MemberNumber": "20080920000007924",
    "First": "JOHN",
    "Last": "DOE",
    "BirthDate": "1930-05-26",
    "MbrStatus": 0
  },
  "MessageId": "getMemberRecSelectFields"
}

getMemberRecSelectFieldsFilterChildren

post

Retrieves a member record with selected fields and filtered children. Description.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
MemberRecMemberNumberstringOptional
Responses
200

Successful operation.

application/json
post/getMemberRecSelectFieldsFilterChildren
POST /nexum/627/persistent/member/getMemberRecSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2761

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "MemberRecMemberNumber": "text",
  "SelectableFields": {
    "IncludeAllMemberRecFields": true,
    "MemberRecFields": {
      "ActiveDuty": true,
      "ActiveDutySeparationDate": true,
      "ActiveDutyStartDate": true,
      "ActiveDutyVerificationDate": true,
      "AltEmail": true,
      "BirthDate": true,
      "Chapter4StatusCode": true,
      "CtrExempt": true,
      "CurrGrossMonthPay": true,
      "CurrNetMonthPay": true,
      "DbaExtendedName": true,
      "DbaFirst": true,
      "DbaLast": true,
      "DbaLongName": true,
      "DbaMiddle": true,
      "DbaNameFormat": true,
      "DbaShortName": true,
      "DbaSuffix": true,
      "DbaTitle": true,
      "DeathDate": true,
      "Email": true,
      "EmployerName": true,
      "ExtendedName": true,
      "First": true,
      "ForeignTin": true,
      "FormW8OnFile": true,
      "GIin": true,
      "HomePhone": true,
      "IdentDocFlag": [
        1
      ],
      "IdentIdDescription": [
        1
      ],
      "IdentIdExpireDate": [
        1
      ],
      "IdentIdIssueDate": [
        1
      ],
      "IdentIdNumber": [
        1
      ],
      "IdentIdType": [
        1
      ],
      "IdentIdVerifyDate": [
        1
      ],
      "IrsCountryCode": true,
      "Last": true,
      "Lei": true,
      "License": true,
      "Lob": true,
      "LongName": true,
      "MbrActivityDate": true,
      "MbrCreateDate": true,
      "MbrCurrMthPayChgDate": true,
      "MbrDisconnectDate": true,
      "MbrExpDate": true,
      "MbrFileType": true,
      "MbrFmLastDate": true,
      "MbrFmLastPurgeDate": true,
      "MbrRecordChangeDate": true,
      "MbrStatus": true,
      "MbrStatusFmDate": true,
      "MemberNumber": true,
      "Middle": true,
      "MobilePhone": true,
      "MothersMaidenName": true,
      "NameFormat": true,
      "NraExemptionCode": true,
      "NraTaxRate": true,
      "Occupation": true,
      "PagerNumber": true,
      "PhoneType": true,
      "PreferredContact": true,
      "PreferredContactMethod": true,
      "Restrict": true,
      "Sex": true,
      "ShortName": true,
      "Ssn": true,
      "SsnType": true,
      "SubstantialOwner": true,
      "Suffix": true,
      "Title": true,
      "UsPersonFlag": true,
      "UserAmount1": true,
      "UserAmount2": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserDate1": true,
      "UserDate2": true,
      "W8ExpirationDate": true,
      "WorkPhone": true,
      "WorkPhoneExtension": true
    },
    "MemberRecFmHistorySelectableFields": {
      "IncludeAllMemberRecFmHistoryFields": true,
      "MemberRecFmHistoryFields": {
        "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": {
    "MemberRecFmHistoryFilter": {
      "StartPostDate": "2026-01-01",
      "EndPostDate": "2026-01-01",
      "Query": "text"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}
200

Successful operation.

{
  "MemberRec": {
    "ActiveDuty": 1,
    "ActiveDutySeparationDate": "2026-01-01",
    "ActiveDutyStartDate": "2026-01-01",
    "ActiveDutyVerificationDate": "2026-01-01",
    "AltEmail": "text",
    "BirthDate": "2026-01-01",
    "Chapter4StatusCode": "text",
    "CtrExempt": 1,
    "CurrGrossMonthPay": 1,
    "CurrNetMonthPay": 1,
    "DbaExtendedName": "text",
    "DbaFirst": "text",
    "DbaLast": "text",
    "DbaLongName": "text",
    "DbaMiddle": "text",
    "DbaNameFormat": 1,
    "DbaShortName": "text",
    "DbaSuffix": "text",
    "DbaTitle": "text",
    "DeathDate": "2026-01-01",
    "Email": "text",
    "EmployerName": "text",
    "ExtendedName": "text",
    "First": "text",
    "ForeignTin": "text",
    "FormW8OnFile": 1,
    "GIin": "text",
    "HomePhone": "text",
    "IdentDocFlag": [
      {
        "EntryId": 1,
        "IdentDocFlag": 1
      }
    ],
    "IdentIdDescription": [
      {
        "EntryId": 1,
        "IdentIdDescription": "text"
      }
    ],
    "IdentIdExpireDate": [
      {
        "EntryId": 1,
        "IdentIdExpireDate": "2026-01-01"
      }
    ],
    "IdentIdIssueDate": [
      {
        "EntryId": 1,
        "IdentIdIssueDate": "2026-01-01"
      }
    ],
    "IdentIdNumber": [
      {
        "EntryId": 1,
        "IdentIdNumber": "text"
      }
    ],
    "IdentIdType": [
      {
        "EntryId": 1,
        "IdentIdType": 1
      }
    ],
    "IdentIdVerifyDate": [
      {
        "EntryId": 1,
        "IdentIdVerifyDate": "2026-01-01"
      }
    ],
    "IrsCountryCode": "text",
    "Last": "text",
    "Lei": "text",
    "License": "text",
    "Lob": "text",
    "LongName": "text",
    "MbrActivityDate": "2026-01-01",
    "MbrCreateDate": "2026-01-01",
    "MbrCurrMthPayChgDate": "2026-01-01",
    "MbrDisconnectDate": "2026-01-01",
    "MbrExpDate": "2026-01-01",
    "MbrFileType": 1,
    "MbrFmLastDate": "2026-01-01",
    "MbrFmLastPurgeDate": "2026-01-01",
    "MbrRecordChangeDate": "2026-01-01",
    "MbrStatus": 1,
    "MbrStatusFmDate": "2026-01-01",
    "MemberNumber": "text",
    "MemberRecFmHistoryList": {
      "hasReachedMaximumListSize": true,
      "MemberRecFmHistory": [
        {
          "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": "2026-01-01",
          "NewCharacter": "text",
          "NewDate": "2026-01-01",
          "NewMoney": 1,
          "NewNumber": 1,
          "NewRate": 1,
          "OldCharacter": "text",
          "OldDate": "2026-01-01",
          "OldMoney": 1,
          "OldNumber": 1,
          "OldRate": 1,
          "PostDate": "2026-01-01",
          "PostTime": 1,
          "ProcessorUser": 1,
          "RecordName": "text",
          "RecordType": 1,
          "SecurityLevels": 1,
          "SequenceNumber": 1,
          "SubFieldNumber": 1,
          "UserNumber": 1,
          "UserOverride": 1
        }
      ]
    },
    "Middle": "text",
    "MobilePhone": "text",
    "MothersMaidenName": "text",
    "NameFormat": 1,
    "NraExemptionCode": "text",
    "NraTaxRate": 1,
    "Occupation": "text",
    "PagerNumber": "text",
    "PhoneType": 1,
    "PreferredContact": "text",
    "PreferredContactMethod": 1,
    "Restrict": 1,
    "Sex": "text",
    "ShortName": "text",
    "Ssn": "text",
    "SsnType": 1,
    "SubstantialOwner": 1,
    "Suffix": "text",
    "Title": "text",
    "UsPersonFlag": 1,
    "UserAmount1": 1,
    "UserAmount2": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserDate1": "2026-01-01",
    "UserDate2": "2026-01-01",
    "W8ExpirationDate": "2026-01-01",
    "WorkPhone": "text",
    "WorkPhoneExtension": "text"
  }
}

getMemberRecFmHistoryPagedListSelectFields

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
MemberRecMemberNumberstringOptional
Responses
200

Successful operation.

application/json
TokenstringOptional
post/getMemberRecFmHistoryPagedListSelectFields
POST /nexum/627/persistent/member/getMemberRecFmHistoryPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1007

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "MemberRecMemberNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllMemberRecFmHistoryFields": true,
    "MemberRecFmHistoryFields": {
      "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": {}
  }
}
200

Successful operation.

{
  "MemberRecFmHistory": [
    {
      "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": "2026-01-01",
      "NewCharacter": "text",
      "NewDate": "2026-01-01",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2026-01-01",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2026-01-01",
      "PostTime": 1,
      "ProcessorUser": 1,
      "RecordName": "text",
      "RecordType": 1,
      "SecurityLevels": 1,
      "SequenceNumber": 1,
      "SubFieldNumber": 1,
      "UserNumber": 1,
      "UserOverride": 1
    }
  ],
  "Token": "text"
}

searchMemberRecFmHistoryPagedSelectFields

post

Searches member records from history with pagination and selected fields. Description.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
MemberRecMemberNumberstringOptional
Responses
200

Successful operation.

application/json
TokenstringOptional
post/searchMemberRecFmHistoryPagedSelectFields
POST /nexum/627/persistent/member/searchMemberRecFmHistoryPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1095

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "MemberRecMemberNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllMemberRecFmHistoryFields": true,
    "MemberRecFmHistoryFields": {
      "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": "2026-01-01",
    "EndPostDate": "2026-01-01",
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {}
  }
}
200

Successful operation.

{
  "MemberRecFmHistory": [
    {
      "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": "2026-01-01",
      "NewCharacter": "text",
      "NewDate": "2026-01-01",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2026-01-01",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2026-01-01",
      "PostTime": 1,
      "ProcessorUser": 1,
      "RecordName": "text",
      "RecordType": 1,
      "SecurityLevels": 1,
      "SequenceNumber": 1,
      "SubFieldNumber": 1,
      "UserNumber": 1,
      "UserOverride": 1
    }
  ],
  "Token": "text"
}

updateMemberRecByID

post

Updates a member record by its ID. Description.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
MemberRecMemberNumberstringOptional
Responses
200

Successful operation.

application/json
post/updateMemberRecByID
POST /nexum/627/persistent/member/updateMemberRecByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MemberRecMemberNumber": "NEXW45",
  "MemberRecFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateMemberRecByID"
}

createMemberRec

post

Creates a member record. Description.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

application/json
MemberRecMemberNumberstringOptional
post/createMemberRec
POST /nexum/627/persistent/member/createMemberRec HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MemberRecFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "MemberRecMemberNumber": "NEXW45",
  "MessageId": "createMemberRec"
}

Last updated

Was this helpful?