MemberService⁠

Manage member records.

Operations⁠

getMemberRecSelectFields⁠

POST

Retrieves a member record with selected fields. Description.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

MemberRecMemberNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/member/getMemberRecSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MemberRecMemberNumber": "0",
  "SelectableFields": {
    "IncludeAllMemberRecFields": false,
    "MemberRecFields": {
      "MemberNumber": true,
      "First": true,
      "Last": true,
      "BirthDate": true,
      "MbrStatus": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getMemberRecSelectFieldsFilterChildren⁠

POST

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

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

MemberRecMemberNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/member/getMemberRecSelectFieldsFilterChildren

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MemberRecMemberNumber": "string",
  "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
    },
    "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
      }
    }
  },
  "ChildrenSearchFilter": {
    "MemberRecFmHistoryFilter": {
      "StartPostDate": "string",
      "EndPostDate": "string",
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getMemberRecFmHistoryPagedListSelectFields⁠

POST

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

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

MemberRecMemberNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/member/getMemberRecFmHistoryPagedListSelectFields

POST /nexum/627/persistent/member/getMemberRecFmHistoryPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MemberRecMemberNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchMemberRecFmHistoryPagedSelectFields⁠

POST

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

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

MemberRecMemberNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/member/searchMemberRecFmHistoryPagedSelectFields

POST /nexum/627/persistent/member/searchMemberRecFmHistoryPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MemberRecMemberNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "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
    }
  },
  "SearchFilter": {
    "StartPostDate": "string",
    "EndPostDate": "string",
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateMemberRecByID⁠

POST

Updates a member record by its ID. Description.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

MemberRecMemberNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/member/updateMemberRecByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "MemberRecMemberNumber": "string",
  "MemberRecFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createMemberRec⁠

POST

Creates a member record. Description.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

Path Parameters

symstringrequired: Sym number

Responses

MemberRecMemberNumberstringoptional

POST/nexum/{sym}/persistent/member/createMemberRec

POST /nexum/627/persistent/member/createMemberRec HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

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