StmtMessages

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getStmtMessages

post

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

StmtMessagesStatementMessageCodeintegerRequired

Responses

200

Successful operation.

application/json

post/getStmtMessages

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "StmtMessagesStatementMessageCode": 30,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "StmtMessages": {
    "DefinedCode": 0,
    "Description": null,
    "Line1": null,
    "StatementMessageCode": 0
  },
  "MessageId": "getStmtMessages"
}

getStmtMessagesSelectFields

post

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

StmtMessagesStatementMessageCodeintegerOptional

Responses

200

Successful operation.

application/json

post/getStmtMessagesSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getStmtMessagesSelectFields 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}"
    }
  },
  "StmtMessagesStatementMessageCode": 30,
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": false,
    "StmtMessagesFields": {
      "StatementMessageCode": true,
      "DefinedCode": true,
      "Description": true,
      "Line1": true
    }
  }
}

200

Successful operation.

{
  "StmtMessages": {
    "DefinedCode": 0,
    "Description": null,
    "Line1": null,
    "StatementMessageCode": 0
  },
  "MessageId": "getStmtMessagesSelectFields"
}

getStmtMessagesPagedList

post

Retrieve StmtMessages 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/getStmtMessagesPagedList

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "StmtMessages": [],
  "Token": null,
  "MessageId": "getStmtMessagesPagedList"
}

getStmtMessagesListSelectFields

post

Retrieve StmtMessages 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/getStmtMessagesListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "StmtMessagesList": [],
  "MessageId": "getStmtMessagesListSelectFields"
}

searchStmtMessagesSelectFields

post

Search StmtMessages 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/searchStmtMessagesSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchStmtMessagesSelectFields 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}"
    }
  },
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "StmtMessagesList": [],
  "MessageId": "searchStmtMessagesSelectFields"
}

getStmtMessagesPagedListSelectFields

post

Retrieve StmtMessages 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/getStmtMessagesPagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "StmtMessages": [
    {
      "Description": null,
      "StatementMessageCode": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getStmtMessagesPagedListSelectFields"
}

searchStmtMessagesPagedSelectFields

post

Search StmtMessages 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/searchStmtMessagesPagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "StmtMessages": [
    {
      "Description": null,
      "StatementMessageCode": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchStmtMessagesPagedSelectFields"
}

updateStmtMessagesByID

post

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

StmtMessagesStatementMessageCodeintegerOptional

Responses

200

Successful operation.

application/json

post/updateStmtMessagesByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateStmtMessagesByID 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}"
    }
  },
  "StmtMessagesStatementMessageCode": 1,
  "StmtMessagesUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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