Skip to content
NexumAPI Docs

OnlineSbAddOn⁠

Perform various operations for Symitar parameters.

Operations⁠

getOnlineSbAddOn⁠

POST

Retrieve OnlineSbAddOn parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

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

getOnlineSbAddOnSelectFields⁠

POST

Retrieve OnlineSbAddOn parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  },
  "OnlineSbAddOnRuleOrdinal": 0,
  "SelectableFields": {
    "OnlineSbAddOnFields": {
      "RuleOrdinal": true,
      "RuleDescription": true,
      "TransactionSourceCode": true
    }
  }
}

getOnlineSbAddOnPagedList⁠

POST

Retrieve OnlineSbAddOn parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

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

getOnlineSbAddOnListSelectFields⁠

POST

Retrieve OnlineSbAddOn parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

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

searchOnlineSbAddOnSelectFields⁠

POST

Search OnlineSbAddOn parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

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

getOnlineSbAddOnPagedListSelectFields⁠

POST

Retrieve OnlineSbAddOn parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "OnlineSbAddOnFields": {
      "RuleOrdinal": true,
      "RuleDescription": true,
      "TransactionSourceCode": true
    }
  }
}