Skip to content
NexumAPI Docs

AnalysisPlan⁠

Perform various operations for Symitar parameters.

Operations⁠

getAnalysisPlanSelectFields⁠

POST

Execute the persistent ParameterService getAnalysisPlanSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "AnalysisPlanIndexAnalysisPlan": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllAnalysisPlanFields": true,
    "AnalysisPlanFields": {
      "CashAmountFree": true,
      "CashAtmTotals": true,
      "CashRate": true,
      "Charge": [
        0
      ],
      "ChargeType": [
        0
      ],
      "DefinedCode": true,
      "Description": true,
      "EarnRateMethod": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "Free": [
        0
      ],
      "IndexAnalysisPlan": true,
      "Locator": true,
      "MaintenanceCharge": true,
      "MaximumCharge": true,
      "MinimumCharge": true,
      "Plan": true,
      "RecType": true,
      "RecordChangeDate": true,
      "Tier1Balance": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getAnalysisPlanPagedListSelectFields⁠

POST

Execute the persistent ParameterService getAnalysisPlanPagedListSelectFields operation.

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
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getAnalysisPlanPagedListSelectFields
POST /nexum/627/persistent/parameter/getAnalysisPlanPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllAnalysisPlanFields": true,
    "AnalysisPlanFields": {
      "CashAmountFree": true,
      "CashAtmTotals": true,
      "CashRate": true,
      "Charge": [
        0
      ],
      "ChargeType": [
        0
      ],
      "DefinedCode": true,
      "Description": true,
      "EarnRateMethod": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "Free": [
        0
      ],
      "IndexAnalysisPlan": true,
      "Locator": true,
      "MaintenanceCharge": true,
      "MaximumCharge": true,
      "MinimumCharge": true,
      "Plan": true,
      "RecType": true,
      "RecordChangeDate": true,
      "Tier1Balance": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchAnalysisPlanPagedSelectFields⁠

POST

Execute the persistent ParameterService searchAnalysisPlanPagedSelectFields operation.

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
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/searchAnalysisPlanPagedSelectFields
POST /nexum/627/persistent/parameter/searchAnalysisPlanPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllAnalysisPlanFields": true,
    "AnalysisPlanFields": {
      "CashAmountFree": true,
      "CashAtmTotals": true,
      "CashRate": true,
      "Charge": [
        0
      ],
      "ChargeType": [
        0
      ],
      "DefinedCode": true,
      "Description": true,
      "EarnRateMethod": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "Free": [
        0
      ],
      "IndexAnalysisPlan": true,
      "Locator": true,
      "MaintenanceCharge": true,
      "MaximumCharge": true,
      "MinimumCharge": true,
      "Plan": true,
      "RecType": true,
      "RecordChangeDate": true,
      "Tier1Balance": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateAnalysisPlanByID⁠

POST

Execute the persistent ParameterService updateAnalysisPlanByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "AnalysisPlanIndexAnalysisPlan": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "AnalysisPlanFields": {
    "CashAmountFree": 0,
    "CashAtmTotals": 0,
    "CashRate": 0,
    "Charge": [
      {
        "EntryId": 0,
        "Charge": 0
      }
    ],
    "ChargeType": [
      {
        "EntryId": 0,
        "ChargeType": 0
      }
    ],
    "DefinedCode": 0,
    "Description": "string",
    "EarnRateMethod": 0,
    "EffectiveDate": "string",
    "ExpirationDate": "string",
    "Free": [
      {
        "EntryId": 0,
        "Free": 0
      }
    ],
    "IndexAnalysisPlan": 0,
    "Locator": 0,
    "MaintenanceCharge": 0,
    "MaximumCharge": 0,
    "MinimumCharge": 0,
    "Plan": 0,
    "RecType": 0,
    "RecordChangeDate": "string",
    "Tier1Balance": 0
  },
  "nxAttributes": {
    "customFields": {}
  }
}