Skip to content
NexumAPI Docs

NonAccountNameService⁠

Manage non-account name records.

Operations⁠

getNonAcctNameFmHistoryPagedListSelectFields⁠

POST

Retrieves a paged 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
Tokenstringoptional
POST/nexum/{sym}/2022.01/nonaccountname/getNonAcctNameFmHistoryPagedListSelectFields
POST /nexum/627/2022.01/nonaccountname/getNonAcctNameFmHistoryPagedListSelectFields 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"
  },
  "SelectableFields": {
    "IncludeAllNonAcctNameFmHistoryFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchNonAcctNameFmHistoryPagedSelectFields⁠

POST

Searches non-account names from history with pagination and selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
NonAcctNameNonAcctNameNumstringoptional
Querystringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/nonaccountname/searchNonAcctNameFmHistoryPagedSelectFields
POST /nexum/627/2022.01/nonaccountname/searchNonAcctNameFmHistoryPagedSelectFields 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"
  },
  "SelectableFields": {
    "IncludeAllNonAcctNameFmHistoryFields": true
  },
  "Query": "string",
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateNonAcctNameByID⁠

POST

Updates a non-account name by its ID.

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/updateNonAcctNameByID
POST /nexum/627/2022.01/nonaccountname/updateNonAcctNameByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

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

createNonAcctName⁠

POST

Creates a non-account name.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameCreatableFields": {
    "Type": 0,
    "Description": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteNonAcctName⁠

POST

Deletes 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
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.
POST/nexum/{sym}/2022.01/nonaccountname/deleteNonAcctName
POST /nexum/627/2022.01/nonaccountname/deleteNonAcctName HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

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