Skip to content
NexumAPI Docs

Preference⁠

Perform various operations on preference records.

Operations⁠

getPreferencePagedListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllPreferenceFields": false,
    "PreferenceFields": {
      "Locator": true,
      "Type": true,
      "RecordChangeDate": true,
      "HbUsername": true,
      "HbEnable": true,
      "AudioEnable": true,
      "Language": true,
      "Reference": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchPreferencePagedSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "Query": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllPreferenceFields": false,
    "PreferenceFields": {
      "Locator": true,
      "Type": true,
      "RecordChangeDate": true,
      "HbUsername": true,
      "HbEnable": true,
      "AudioEnable": true,
      "Language": true,
      "Reference": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getPreferenceAccess⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PreferenceLocator": 0,
  "PreferenceAccessLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getPreferenceAccessSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PreferenceLocator": 0,
  "PreferenceAccessLocator": 0,
  "SelectableFields": {
    "IncludeAllPreferenceAccessFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getPreferenceAccessPagedList⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PreferenceLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getPreferenceAccessListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PreferenceLocator": 0,
  "SelectableFields": {
    "IncludeAllPreferenceAccessFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}