OnlineFee

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getOnlineFee

post

Retrieve OnlineFee 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

OnlineFeeRuleOrdinalintegerRequired

Responses

200

Successful operation.

application/json

post/getOnlineFee

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "OnlineFee": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getOnlineFee"
}

getOnlineFeeSelectFields

post

Retrieve OnlineFee 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

OnlineFeeRuleOrdinalintegerOptional

Responses

200

Successful operation.

application/json

post/getOnlineFeeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "OnlineFeeRuleOrdinal": 0,
  "SelectableFields": {
    "OnlineFeeFields": {
      "RuleOrdinal": true,
      "RuleDescription": true,
      "FeeDescription": true
    }
  }
}

200

Successful operation.

{
  "OnlineFee": {
    "FeeDescription": "Online Fee",
    "RuleDescription": "Online Fee",
    "RuleOrdinal": 0
  },
  "MessageId": "getOnlineFeeSelectFields"
}

getOnlineFeePagedList

post

Retrieve OnlineFee 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/getOnlineFeePagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getOnlineFeePagedList 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.

{
  "OnlineFee": [],
  "Token": null,
  "MessageId": "getOnlineFeePagedList"
}

getOnlineFeeListSelectFields

post

Retrieve OnlineFee 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/getOnlineFeeListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "OnlineFeeList": [],
  "MessageId": "getOnlineFeeListSelectFields"
}

searchOnlineFeeSelectFields

post

Search OnlineFee 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/searchOnlineFeeSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "OnlineFeeList": [],
  "MessageId": "searchOnlineFeeSelectFields"
}

getOnlineFeePagedListSelectFields

post

Retrieve OnlineFee 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/getOnlineFeePagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "OnlineFeeFields": {
      "RuleOrdinal": true,
      "RuleDescription": true,
      "FeeDescription": true
    }
  }
}

200

Successful operation.

{
  "OnlineFee": [
    {
      "FeeDescription": "Online Fee",
      "RuleDescription": "Online Fee",
      "RuleOrdinal": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getOnlineFeePagedListSelectFields"
}

searchOnlineFeePagedSelectFields

post

Search OnlineFee 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/searchOnlineFeePagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "OnlineFeeFields": {
      "RuleOrdinal": true,
      "RuleDescription": true,
      "FeeDescription": true
    }
  }
}

200

Successful operation.

{
  "OnlineFee": [
    {
      "FeeDescription": "Online Fee",
      "RuleDescription": "Online Fee",
      "RuleOrdinal": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchOnlineFeePagedSelectFields"
}

updateOnlineFeeByID

post

Update OnlineFee 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

OnlineFeeRuleOrdinalintegerOptional

Responses

200

Successful operation.

application/json

post/updateOnlineFeeByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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