Skip to content
NexumAPI Docs

NonAccountNameService⁠

Manage non-account name records.

Operations⁠

getNonAcctName⁠

POST

Retrieves a non-account name.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

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

getNonAcctNameSelectFields⁠

POST

Retrieves a non-account name with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameNonAcctNameNum": "0",
  "SelectableFields": {
    "IncludeAllNonAcctNameFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getNonAcctNameSelectFieldsFilterChildren⁠

POST

Retrieves a non-account name with selected fields and filtered children.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameNonAcctNameNum": "0",
  "SelectableFields": {
    "IncludeAllNonAcctNameFields": true
  },
  "ChildrenSearchFilter": {
    "NonAcctNameFmHistoryFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getNonAcctNameFmHistoryPagedList⁠

POST

Retrieves a paged list of non-account names from history.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameNonAcctNameNum": "0",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "REPLACE_WITH_YOUR_TOKEN"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getNonAcctNameFmHistoryListSelectFields⁠

POST

Retrieves a list of non-account names with selected fields from history.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameNonAcctNameNum": "0",
  "SelectableFields": {
    "IncludeAllNonAcctNameFmHistoryFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchNonAcctNameFmHistorySelectFields⁠

POST

Searches non-account names from history with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameNonAcctNameNum": "0",
  "SelectableFields": {
    "IncludeAllNonAcctNameFmHistoryFields": true
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}