StmtMessages

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getStmtMessages

post

Retrieve getStmtMessages data.

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: 161

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "StmtMessagesStatementMessageCode": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StmtMessages": {
    "DefinedCode": 1,
    "Description": "text",
    "Line1": "text",
    "Line10": "text",
    "Line11": "text",
    "Line12": "text",
    "Line2": "text",
    "Line3": "text",
    "Line4": "text",
    "Line5": "text",
    "Line6": "text",
    "Line7": "text",
    "Line8": "text",
    "Line9": "text",
    "StatementMessageCode": 1
  }
}

getStmtMessagesSelectFields

post

Retrieve getStmtMessagesSelectFields data.

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: 466

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "StmtMessagesStatementMessageCode": 1,
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true,
    "StmtMessagesFields": {
      "DefinedCode": true,
      "Description": true,
      "Line1": true,
      "Line10": true,
      "Line11": true,
      "Line12": true,
      "Line2": true,
      "Line3": true,
      "Line4": true,
      "Line5": true,
      "Line6": true,
      "Line7": true,
      "Line8": true,
      "Line9": true,
      "StatementMessageCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StmtMessages": {
    "DefinedCode": 1,
    "Description": "text",
    "Line1": "text",
    "Line10": "text",
    "Line11": "text",
    "Line12": "text",
    "Line2": "text",
    "Line3": "text",
    "Line4": "text",
    "Line5": "text",
    "Line6": "text",
    "Line7": "text",
    "Line8": "text",
    "Line9": "text",
    "StatementMessageCode": 1
  }
}

getStmtMessagesPagedList

post

Retrieve getStmtMessagesPagedList data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

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: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StmtMessages": [
    {
      "DefinedCode": 1,
      "Description": "text",
      "Line1": "text",
      "Line10": "text",
      "Line11": "text",
      "Line12": "text",
      "Line2": "text",
      "Line3": "text",
      "Line4": "text",
      "Line5": "text",
      "Line6": "text",
      "Line7": "text",
      "Line8": "text",
      "Line9": "text",
      "StatementMessageCode": 1
    }
  ],
  "Token": "text"
}

getStmtMessagesListSelectFields

post

Retrieve getStmtMessagesListSelectFields data.

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: 429

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true,
    "StmtMessagesFields": {
      "DefinedCode": true,
      "Description": true,
      "Line1": true,
      "Line10": true,
      "Line11": true,
      "Line12": true,
      "Line2": true,
      "Line3": true,
      "Line4": true,
      "Line5": true,
      "Line6": true,
      "Line7": true,
      "Line8": true,
      "Line9": true,
      "StatementMessageCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StmtMessagesList": {
    "hasReachedMaximumListSize": true,
    "StmtMessages": [
      {
        "DefinedCode": 1,
        "Description": "text",
        "Line1": "text",
        "Line10": "text",
        "Line11": "text",
        "Line12": "text",
        "Line2": "text",
        "Line3": "text",
        "Line4": "text",
        "Line5": "text",
        "Line6": "text",
        "Line7": "text",
        "Line8": "text",
        "Line9": "text",
        "StatementMessageCode": 1
      }
    ]
  }
}

searchStmtMessagesSelectFields

post

Retrieve a list of select fields for statement messages

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: 461

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true,
    "StmtMessagesFields": {
      "DefinedCode": true,
      "Description": true,
      "Line1": true,
      "Line10": true,
      "Line11": true,
      "Line12": true,
      "Line2": true,
      "Line3": true,
      "Line4": true,
      "Line5": true,
      "Line6": true,
      "Line7": true,
      "Line8": true,
      "Line9": true,
      "StatementMessageCode": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StmtMessagesList": {
    "hasReachedMaximumListSize": true,
    "StmtMessages": [
      {
        "DefinedCode": 1,
        "Description": "text",
        "Line1": "text",
        "Line10": "text",
        "Line11": "text",
        "Line12": "text",
        "Line2": "text",
        "Line3": "text",
        "Line4": "text",
        "Line5": "text",
        "Line6": "text",
        "Line7": "text",
        "Line8": "text",
        "Line9": "text",
        "StatementMessageCode": 1
      }
    ]
  }
}

getStmtMessagesPagedListSelectFields

post

Retrieve getStmtMessagesPagedListSelectFields data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

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: 523

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true,
    "StmtMessagesFields": {
      "DefinedCode": true,
      "Description": true,
      "Line1": true,
      "Line10": true,
      "Line11": true,
      "Line12": true,
      "Line2": true,
      "Line3": true,
      "Line4": true,
      "Line5": true,
      "Line6": true,
      "Line7": true,
      "Line8": true,
      "Line9": true,
      "StatementMessageCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StmtMessages": [
    {
      "DefinedCode": 1,
      "Description": "text",
      "Line1": "text",
      "Line10": "text",
      "Line11": "text",
      "Line12": "text",
      "Line2": "text",
      "Line3": "text",
      "Line4": "text",
      "Line5": "text",
      "Line6": "text",
      "Line7": "text",
      "Line8": "text",
      "Line9": "text",
      "StatementMessageCode": 1
    }
  ],
  "Token": "text"
}

searchStmtMessagesPagedSelectFields

post

Retrieve a paged list of select fields for statement messages

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

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: 538

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true,
    "StmtMessagesFields": {
      "DefinedCode": true,
      "Description": true,
      "Line1": true,
      "Line10": true,
      "Line11": true,
      "Line12": true,
      "Line2": true,
      "Line3": true,
      "Line4": true,
      "Line5": true,
      "Line6": true,
      "Line7": true,
      "Line8": true,
      "Line9": true,
      "StatementMessageCode": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StmtMessages": [
    {
      "DefinedCode": 1,
      "Description": "text",
      "Line1": "text",
      "Line10": "text",
      "Line11": "text",
      "Line12": "text",
      "Line2": "text",
      "Line3": "text",
      "Line4": "text",
      "Line5": "text",
      "Line6": "text",
      "Line7": "text",
      "Line8": "text",
      "Line9": "text",
      "StatementMessageCode": 1
    }
  ],
  "Token": "text"
}

updateStmtMessagesByID

post

Update statement messages by ID

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: 413

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "StmtMessagesStatementMessageCode": 1,
  "StmtMessagesUpdatableFields": {
    "DefinedCode": 1,
    "Description": "text",
    "Line1": "text",
    "Line10": "text",
    "Line11": "text",
    "Line12": "text",
    "Line2": "text",
    "Line3": "text",
    "Line4": "text",
    "Line5": "text",
    "Line6": "text",
    "Line7": "text",
    "Line8": "text",
    "Line9": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}