DivIndexLocal

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getDivIndexLocal

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

DivIndexLocalDividendIndexTableintegerRequired

Responses

200

Successful operation.

application/json

post/getDivIndexLocal

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "DivIndexLocalDividendIndexTable": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "DivIndexLocal": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getDivIndexLocal"
}

getDivIndexLocalSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

DivIndexLocalDividendIndexTableintegerOptional

Responses

200

Successful operation.

application/json

post/getDivIndexLocalSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "BranchId": 0,
  "DivIndexLocalDividendIndexTable": 0,
  "SelectableFields": {
    "DivIndexLocalFields": {
      "DividendIndexTable": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "DivIndexLocal": {
    "BackdatedFlag": [],
    "BalanceCutoff": [],
    "BalanceStatus": [],
    "CurrentMonthAvgRate": null,
    "Description": null,
    "DividendIndexTable": 0,
    "InactiveStatusDate": null,
    "IndexDate": [],
    "IndexRate": [],
    "PendingBalance": [],
    "PendingRate": [],
    "Status": []
  },
  "MessageId": "getDivIndexLocalSelectFields"
}

getDivIndexLocalPagedList

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getDivIndexLocalPagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "DivIndexLocal": [],
  "Token": null,
  "MessageId": "getDivIndexLocalPagedList"
}

getDivIndexLocalListSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getDivIndexLocalListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllDivIndexLocalFields": true
  }
}

200

Successful operation.

{
  "DivIndexLocalList": [],
  "MessageId": "getDivIndexLocalListSelectFields"
}

searchDivIndexLocalSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/searchDivIndexLocalSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllDivIndexLocalFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "DivIndexLocalList": [],
  "MessageId": "searchDivIndexLocalSelectFields"
}

getDivIndexLocalPagedListSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getDivIndexLocalPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "BranchId": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "DivIndexLocalFields": {
      "DividendIndexTable": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "DivIndexLocal": [
    {
      "BackdatedFlag": [],
      "BalanceCutoff": [],
      "BalanceStatus": [],
      "CurrentMonthAvgRate": null,
      "Description": null,
      "DividendIndexTable": 0,
      "InactiveStatusDate": null,
      "IndexDate": [],
      "IndexRate": [],
      "PendingBalance": [],
      "PendingRate": [],
      "Status": []
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getDivIndexLocalPagedListSelectFields"
}

searchDivIndexLocalPagedSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchDivIndexLocalPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "BranchId": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "DivIndexLocalFields": {
      "DividendIndexTable": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "DivIndexLocal": [
    {
      "BackdatedFlag": [],
      "BalanceCutoff": [],
      "BalanceStatus": [],
      "CurrentMonthAvgRate": null,
      "Description": null,
      "DividendIndexTable": 0,
      "InactiveStatusDate": null,
      "IndexDate": [],
      "IndexRate": [],
      "PendingBalance": [],
      "PendingRate": [],
      "Status": []
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchDivIndexLocalPagedSelectFields"
}

updateDivIndexLocalByID

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

DivIndexLocalDividendIndexTableintegerOptional

Responses

200

Successful operation.

application/json

post/updateDivIndexLocalByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "DivIndexLocalDividendIndexTable": 1,
  "DivIndexLocalUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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