StmtMailName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getStmtMailName

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

StmtMailNameStatementMailCodeintegerRequired

Responses

200

Successful operation.

application/json

post/getStmtMailName

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

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

200

Successful operation.

{
  "StmtMailName": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getStmtMailName"
}

getStmtMailNameSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

StmtMailNameStatementMailCodeintegerOptional

Responses

200

Successful operation.

application/json

post/getStmtMailNameSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "StmtMailNameStatementMailCode": 1,
  "SelectableFields": {
    "StmtMailNameFields": {
      "StatementMailCode": true,
      "StatementMailCodeName": true
    }
  }
}

200

Successful operation.

{
  "StmtMailName": {
    "StatementMailCode": 1,
    "StatementMailCodeName": "Statement Mail Code 01"
  },
  "MessageId": "getStmtMailNameSelectFields"
}

getStmtMailNamePagedList

post

Retrieve StmtMailName 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/getStmtMailNamePagedList

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

{
  "StmtMailName": [],
  "Token": null,
  "MessageId": "getStmtMailNamePagedList"
}

getStmtMailNameListSelectFields

post

Retrieve StmtMailName 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/getStmtMailNameListSelectFields

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

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

200

Successful operation.

{
  "StmtMailNameList": [],
  "MessageId": "getStmtMailNameListSelectFields"
}

searchStmtMailNameSelectFields

post

Search StmtMailName 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/searchStmtMailNameSelectFields

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

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

200

Successful operation.

{
  "StmtMailNameList": [],
  "MessageId": "searchStmtMailNameSelectFields"
}

getStmtMailNamePagedListSelectFields

post

Retrieve StmtMailName 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/getStmtMailNamePagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "StmtMailNameFields": {
      "StatementMailCode": true,
      "StatementMailCodeName": true
    }
  }
}

200

Successful operation.

{
  "StmtMailName": [
    {
      "StatementMailCode": 1,
      "StatementMailCodeName": "Statement Mail Code 01"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getStmtMailNamePagedListSelectFields"
}

searchStmtMailNamePagedSelectFields

post

Search StmtMailName 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/searchStmtMailNamePagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "StmtMailNameFields": {
      "StatementMailCode": true,
      "StatementMailCodeName": true
    }
  }
}

200

Successful operation.

{
  "StmtMailName": [
    {
      "StatementMailCode": 1,
      "StatementMailCodeName": "Statement Mail Code 01"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchStmtMailNamePagedSelectFields"
}

updateStmtMailNameByID

post

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

StmtMailNameStatementMailCodeintegerOptional

Responses

200

Successful operation.

application/json

post/updateStmtMailNameByID

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

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

200

Successful operation.

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