AnalysisPlan
Perform various operations for Symitar parameters.
Operations
Retrieve the analysis plan information
Authorizations
Body
AnalysisPlanIndexAnalysisPlanintegerRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getAnalysisPlan HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 158
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"AnalysisPlanIndexAnalysisPlan": 1,
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
200
Successful operation.
{
"AnalysisPlan": {
"CashAmountFree": 1,
"CashAtmTotals": 1,
"CashRate": 1,
"Charge": [
{
"EntryId": 1,
"Charge": 1
}
],
"ChargeType": [
{
"EntryId": 1,
"ChargeType": 1
}
],
"DefinedCode": 1,
"Description": "text",
"EarnRateMethod": 1,
"EffectiveDate": "2025-06-23",
"ExpirationDate": "2025-06-23",
"Free": [
{
"EntryId": 1,
"Free": 1
}
],
"IndexAnalysisPlan": 1,
"Locator": 1,
"MaintenanceCharge": 1,
"MaximumCharge": 1,
"MinimumCharge": 1,
"Plan": 1,
"RecType": 1,
"RecordChangeDate": "2025-06-23",
"Tier1Balance": 1,
"Tier1EarnRate": 1,
"Tier2Balance": 1,
"Tier2EarnRate": 1,
"Tier3Balance": 1,
"Tier3EarnRate": 1,
"Tier4Balance": 1,
"Tier4EarnRate": 1
}
}
Retrieve analysis plans with selected fields
Authorizations
Body
AnalysisPlanIndexAnalysisPlanintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getAnalysisPlanSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 763
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"AnalysisPlanIndexAnalysisPlan": 1,
"SelectableFields": {
"IncludeAllAnalysisPlanFields": true,
"AnalysisPlanFields": {
"CashAmountFree": true,
"CashAtmTotals": true,
"CashRate": true,
"Charge": [
1
],
"ChargeType": [
1
],
"DefinedCode": true,
"Description": true,
"EarnRateMethod": true,
"EffectiveDate": true,
"ExpirationDate": true,
"Free": [
1
],
"IndexAnalysisPlan": true,
"Locator": true,
"MaintenanceCharge": true,
"MaximumCharge": true,
"MinimumCharge": true,
"Plan": true,
"RecType": true,
"RecordChangeDate": true,
"Tier1Balance": true,
"Tier1EarnRate": true,
"Tier2Balance": true,
"Tier2EarnRate": true,
"Tier3Balance": true,
"Tier3EarnRate": true,
"Tier4Balance": true,
"Tier4EarnRate": true
}
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
200
Successful operation.
{
"AnalysisPlan": {
"CashAmountFree": 1,
"CashAtmTotals": 1,
"CashRate": 1,
"Charge": [
{
"EntryId": 1,
"Charge": 1
}
],
"ChargeType": [
{
"EntryId": 1,
"ChargeType": 1
}
],
"DefinedCode": 1,
"Description": "text",
"EarnRateMethod": 1,
"EffectiveDate": "2025-06-23",
"ExpirationDate": "2025-06-23",
"Free": [
{
"EntryId": 1,
"Free": 1
}
],
"IndexAnalysisPlan": 1,
"Locator": 1,
"MaintenanceCharge": 1,
"MaximumCharge": 1,
"MinimumCharge": 1,
"Plan": 1,
"RecType": 1,
"RecordChangeDate": "2025-06-23",
"Tier1Balance": 1,
"Tier1EarnRate": 1,
"Tier2Balance": 1,
"Tier2EarnRate": 1,
"Tier3Balance": 1,
"Tier3EarnRate": 1,
"Tier4Balance": 1,
"Tier4EarnRate": 1
}
}
Retrieve a paged list of analysis plans
Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getAnalysisPlanPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 218
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"PagingRequestContext": {
"NumberOfRecordsToReturn": 1,
"NumberOfRecordsToSkip": 1,
"Token": "text"
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
200
Successful operation.
{
"AnalysisPlan": [
{
"CashAmountFree": 1,
"CashAtmTotals": 1,
"CashRate": 1,
"Charge": [
{
"EntryId": 1,
"Charge": 1
}
],
"ChargeType": [
{
"EntryId": 1,
"ChargeType": 1
}
],
"DefinedCode": 1,
"Description": "text",
"EarnRateMethod": 1,
"EffectiveDate": "2025-06-23",
"ExpirationDate": "2025-06-23",
"Free": [
{
"EntryId": 1,
"Free": 1
}
],
"IndexAnalysisPlan": 1,
"Locator": 1,
"MaintenanceCharge": 1,
"MaximumCharge": 1,
"MinimumCharge": 1,
"Plan": 1,
"RecType": 1,
"RecordChangeDate": "2025-06-23",
"Tier1Balance": 1,
"Tier1EarnRate": 1,
"Tier2Balance": 1,
"Tier2EarnRate": 1,
"Tier3Balance": 1,
"Tier3EarnRate": 1,
"Tier4Balance": 1,
"Tier4EarnRate": 1
}
],
"Token": "text"
}
Retrieve the list of analysis plans with selectable fields
Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getAnalysisPlanListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 729
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"SelectableFields": {
"IncludeAllAnalysisPlanFields": true,
"AnalysisPlanFields": {
"CashAmountFree": true,
"CashAtmTotals": true,
"CashRate": true,
"Charge": [
1
],
"ChargeType": [
1
],
"DefinedCode": true,
"Description": true,
"EarnRateMethod": true,
"EffectiveDate": true,
"ExpirationDate": true,
"Free": [
1
],
"IndexAnalysisPlan": true,
"Locator": true,
"MaintenanceCharge": true,
"MaximumCharge": true,
"MinimumCharge": true,
"Plan": true,
"RecType": true,
"RecordChangeDate": true,
"Tier1Balance": true,
"Tier1EarnRate": true,
"Tier2Balance": true,
"Tier2EarnRate": true,
"Tier3Balance": true,
"Tier3EarnRate": true,
"Tier4Balance": true,
"Tier4EarnRate": true
}
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
200
Successful operation.
{
"AnalysisPlanList": {
"hasReachedMaximumListSize": true,
"AnalysisPlan": [
{
"CashAmountFree": 1,
"CashAtmTotals": 1,
"CashRate": 1,
"Charge": [
{
"EntryId": 1,
"Charge": 1
}
],
"ChargeType": [
{
"EntryId": 1,
"ChargeType": 1
}
],
"DefinedCode": 1,
"Description": "text",
"EarnRateMethod": 1,
"EffectiveDate": "2025-06-23",
"ExpirationDate": "2025-06-23",
"Free": [
{
"EntryId": 1,
"Free": 1
}
],
"IndexAnalysisPlan": 1,
"Locator": 1,
"MaintenanceCharge": 1,
"MaximumCharge": 1,
"MinimumCharge": 1,
"Plan": 1,
"RecType": 1,
"RecordChangeDate": "2025-06-23",
"Tier1Balance": 1,
"Tier1EarnRate": 1,
"Tier2Balance": 1,
"Tier2EarnRate": 1,
"Tier3Balance": 1,
"Tier3EarnRate": 1,
"Tier4Balance": 1,
"Tier4EarnRate": 1
}
]
}
}
Search analysis plan select fields
Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchAnalysisPlanSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 761
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"SelectableFields": {
"IncludeAllAnalysisPlanFields": true,
"AnalysisPlanFields": {
"CashAmountFree": true,
"CashAtmTotals": true,
"CashRate": true,
"Charge": [
1
],
"ChargeType": [
1
],
"DefinedCode": true,
"Description": true,
"EarnRateMethod": true,
"EffectiveDate": true,
"ExpirationDate": true,
"Free": [
1
],
"IndexAnalysisPlan": true,
"Locator": true,
"MaintenanceCharge": true,
"MaximumCharge": true,
"MinimumCharge": true,
"Plan": true,
"RecType": true,
"RecordChangeDate": true,
"Tier1Balance": true,
"Tier1EarnRate": true,
"Tier2Balance": true,
"Tier2EarnRate": true,
"Tier3Balance": true,
"Tier3EarnRate": true,
"Tier4Balance": true,
"Tier4EarnRate": true
}
},
"SearchFilter": {
"Query": "text"
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
200
Successful operation.
{
"AnalysisPlanList": {
"hasReachedMaximumListSize": true,
"AnalysisPlan": [
{
"CashAmountFree": 1,
"CashAtmTotals": 1,
"CashRate": 1,
"Charge": [
{
"EntryId": 1,
"Charge": 1
}
],
"ChargeType": [
{
"EntryId": 1,
"ChargeType": 1
}
],
"DefinedCode": 1,
"Description": "text",
"EarnRateMethod": 1,
"EffectiveDate": "2025-06-23",
"ExpirationDate": "2025-06-23",
"Free": [
{
"EntryId": 1,
"Free": 1
}
],
"IndexAnalysisPlan": 1,
"Locator": 1,
"MaintenanceCharge": 1,
"MaximumCharge": 1,
"MinimumCharge": 1,
"Plan": 1,
"RecType": 1,
"RecordChangeDate": "2025-06-23",
"Tier1Balance": 1,
"Tier1EarnRate": 1,
"Tier2Balance": 1,
"Tier2EarnRate": 1,
"Tier3Balance": 1,
"Tier3EarnRate": 1,
"Tier4Balance": 1,
"Tier4EarnRate": 1
}
]
}
}
Retrieve a paged list of analysis plans with selected fields
Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getAnalysisPlanPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 823
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"PagingRequestContext": {
"NumberOfRecordsToReturn": 1,
"NumberOfRecordsToSkip": 1,
"Token": "text"
},
"SelectableFields": {
"IncludeAllAnalysisPlanFields": true,
"AnalysisPlanFields": {
"CashAmountFree": true,
"CashAtmTotals": true,
"CashRate": true,
"Charge": [
1
],
"ChargeType": [
1
],
"DefinedCode": true,
"Description": true,
"EarnRateMethod": true,
"EffectiveDate": true,
"ExpirationDate": true,
"Free": [
1
],
"IndexAnalysisPlan": true,
"Locator": true,
"MaintenanceCharge": true,
"MaximumCharge": true,
"MinimumCharge": true,
"Plan": true,
"RecType": true,
"RecordChangeDate": true,
"Tier1Balance": true,
"Tier1EarnRate": true,
"Tier2Balance": true,
"Tier2EarnRate": true,
"Tier3Balance": true,
"Tier3EarnRate": true,
"Tier4Balance": true,
"Tier4EarnRate": true
}
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
200
Successful operation.
{
"AnalysisPlan": [
{
"CashAmountFree": 1,
"CashAtmTotals": 1,
"CashRate": 1,
"Charge": [
{
"EntryId": 1,
"Charge": 1
}
],
"ChargeType": [
{
"EntryId": 1,
"ChargeType": 1
}
],
"DefinedCode": 1,
"Description": "text",
"EarnRateMethod": 1,
"EffectiveDate": "2025-06-23",
"ExpirationDate": "2025-06-23",
"Free": [
{
"EntryId": 1,
"Free": 1
}
],
"IndexAnalysisPlan": 1,
"Locator": 1,
"MaintenanceCharge": 1,
"MaximumCharge": 1,
"MinimumCharge": 1,
"Plan": 1,
"RecType": 1,
"RecordChangeDate": "2025-06-23",
"Tier1Balance": 1,
"Tier1EarnRate": 1,
"Tier2Balance": 1,
"Tier2EarnRate": 1,
"Tier3Balance": 1,
"Tier3EarnRate": 1,
"Tier4Balance": 1,
"Tier4EarnRate": 1
}
],
"Token": "text"
}
Search analysis plan paged select fields
Authorizations
Body
QuerystringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchAnalysisPlanPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 838
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"PagingRequestContext": {
"NumberOfRecordsToReturn": 1,
"NumberOfRecordsToSkip": 1,
"Token": "text"
},
"SelectableFields": {
"IncludeAllAnalysisPlanFields": true,
"AnalysisPlanFields": {
"CashAmountFree": true,
"CashAtmTotals": true,
"CashRate": true,
"Charge": [
1
],
"ChargeType": [
1
],
"DefinedCode": true,
"Description": true,
"EarnRateMethod": true,
"EffectiveDate": true,
"ExpirationDate": true,
"Free": [
1
],
"IndexAnalysisPlan": true,
"Locator": true,
"MaintenanceCharge": true,
"MaximumCharge": true,
"MinimumCharge": true,
"Plan": true,
"RecType": true,
"RecordChangeDate": true,
"Tier1Balance": true,
"Tier1EarnRate": true,
"Tier2Balance": true,
"Tier2EarnRate": true,
"Tier3Balance": true,
"Tier3EarnRate": true,
"Tier4Balance": true,
"Tier4EarnRate": true
}
},
"Query": "text",
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
200
Successful operation.
{
"AnalysisPlan": [
{
"CashAmountFree": 1,
"CashAtmTotals": 1,
"CashRate": 1,
"Charge": [
{
"EntryId": 1,
"Charge": 1
}
],
"ChargeType": [
{
"EntryId": 1,
"ChargeType": 1
}
],
"DefinedCode": 1,
"Description": "text",
"EarnRateMethod": 1,
"EffectiveDate": "2025-06-23",
"ExpirationDate": "2025-06-23",
"Free": [
{
"EntryId": 1,
"Free": 1
}
],
"IndexAnalysisPlan": 1,
"Locator": 1,
"MaintenanceCharge": 1,
"MaximumCharge": 1,
"MinimumCharge": 1,
"Plan": 1,
"RecType": 1,
"RecordChangeDate": "2025-06-23",
"Tier1Balance": 1,
"Tier1EarnRate": 1,
"Tier2Balance": 1,
"Tier2EarnRate": 1,
"Tier3Balance": 1,
"Tier3EarnRate": 1,
"Tier4Balance": 1,
"Tier4EarnRate": 1
}
],
"Token": "text"
}
Update Analysis Plan by ID
Authorizations
Body
AnalysisPlanIndexAnalysisPlanintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/updateAnalysisPlanByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 686
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"AnalysisPlanIndexAnalysisPlan": 1,
"AnalysisPlanUpdatableFields": {
"CashAmountFree": 1,
"CashAtmTotals": 1,
"CashRate": 1,
"Charge": [
{
"EntryId": 1,
"Charge": 1
}
],
"ChargeType": [
{
"EntryId": 1,
"ChargeType": 1
}
],
"DefinedCode": 1,
"Description": "text",
"EarnRateMethod": 1,
"EffectiveDate": "2025-06-23",
"ExpirationDate": "2025-06-23",
"Free": [
{
"EntryId": 1,
"Free": 1
}
],
"MaintenanceCharge": 1,
"MaximumCharge": 1,
"MinimumCharge": 1,
"Plan": 1,
"RecType": 1,
"Tier1Balance": 1,
"Tier1EarnRate": 1,
"Tier2Balance": 1,
"Tier2EarnRate": 1,
"Tier3Balance": 1,
"Tier3EarnRate": 1,
"Tier4Balance": 1,
"Tier4EarnRate": 1
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
200
Successful operation.
{
"UpdateStatus": {
"isAllFieldsUpdateSuccess": true,
"FailedUpdateStatus": [
{
"Record": "text",
"ErrorCode": "text",
"ErrorMessage": "text",
"PrimaryKeyField": [
{
"Name": "text",
"Value": "text"
}
]
}
]
}
}
Last updated
Was this helpful?