DivTable

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getDivTable

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

DivTableTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getDivTable

POST /nexum/627/2022.01/parameter/getDivTable HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DivTableType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "DivTable": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getDivTable"
}

getDivTableSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

DivTableTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getDivTableSelectFields

POST /nexum/627/2022.01/parameter/getDivTableSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "DivTableType": 0,
  "SelectableFields": {
    "DivTableFields": {
      "Type": true,
      "Method": true,
      "Frequency": true
    }
  }
}

200

Successful operation.

{
  "DivTable": {
    "BalanceCutoff": [],
    "CollectedBalMaxHoldDays": null,
    "Compounding": null,
    "DefinedCode": null,
    "DivIndexTableOption": null,
    "FillInRateMethod": null,
    "Frequency": 3,
    "Increment": null,
    "LrbGraceDays": [],
    "MarginRate": [],
    "Method": 0,
    "MinDailyBalance": null,
    "MinimumBalance": null,
    "NewAccountCode": null,
    "PaymentCode": null,
    "PostAverageBalanceComment": null,
    "Rate": [],
    "RateSelection": null,
    "RelCodeList": [],
    "ScheduleType": null,
    "Table": [],
    "Type": 0
  },
  "MessageId": "getDivTableSelectFields"
}

getDivTablePagedList

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getDivTablePagedList

POST /nexum/627/2022.01/parameter/getDivTablePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "DivTable": [],
  "Token": null,
  "MessageId": "getDivTablePagedList"
}

getDivTableListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getDivTableListSelectFields

POST /nexum/627/2022.01/parameter/getDivTableListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllDivTableFields": true
  }
}

200

Successful operation.

{
  "DivTableList": [],
  "MessageId": "getDivTableListSelectFields"
}

searchDivTableSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchDivTableSelectFields

POST /nexum/627/2022.01/parameter/searchDivTableSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllDivTableFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "DivTableList": [],
  "MessageId": "searchDivTableSelectFields"
}

getDivTablePagedListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getDivTablePagedListSelectFields

POST /nexum/627/2022.01/parameter/getDivTablePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "DivTableFields": {
      "Type": true,
      "Method": true,
      "Frequency": true
    }
  }
}

200

Successful operation.

{
  "DivTable": [
    {
      "BalanceCutoff": [],
      "CollectedBalMaxHoldDays": null,
      "Compounding": null,
      "DefinedCode": null,
      "DivIndexTableOption": null,
      "FillInRateMethod": null,
      "Frequency": 3,
      "Increment": null,
      "LrbGraceDays": [],
      "MarginRate": [],
      "Method": 0,
      "MinDailyBalance": null,
      "MinimumBalance": null,
      "NewAccountCode": null,
      "PaymentCode": null,
      "PostAverageBalanceComment": null,
      "Rate": [],
      "RateSelection": null,
      "RelCodeList": [],
      "ScheduleType": null,
      "Table": [],
      "Type": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getDivTablePagedListSelectFields"
}

searchDivTablePagedSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchDivTablePagedSelectFields

POST /nexum/627/2022.01/parameter/searchDivTablePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "DivTableFields": {
      "Type": true,
      "Method": true,
      "Frequency": true
    }
  }
}

200

Successful operation.

{
  "DivTable": [
    {
      "BalanceCutoff": [],
      "CollectedBalMaxHoldDays": null,
      "Compounding": null,
      "DefinedCode": null,
      "DivIndexTableOption": null,
      "FillInRateMethod": null,
      "Frequency": 3,
      "Increment": null,
      "LrbGraceDays": [],
      "MarginRate": [],
      "Method": 0,
      "MinDailyBalance": null,
      "MinimumBalance": null,
      "NewAccountCode": null,
      "PaymentCode": null,
      "PostAverageBalanceComment": null,
      "Rate": [],
      "RateSelection": null,
      "RelCodeList": [],
      "ScheduleType": null,
      "Table": [],
      "Type": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchDivTablePagedSelectFields"
}

updateDivTableByID

post

Update DivTable parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

DivTableTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateDivTableByID

POST /nexum/627/2022.01/parameter/updateDivTableByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DivTableType": 1,
  "DivTableUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateDivTableByID"
}