OnlineFile

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getOnlineFile

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

OnlineFileFileRecordintegerRequired

Responses

200

Successful operation.

application/json

post/getOnlineFile

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

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

200

Successful operation.

{
  "OnlineFile": {
    "AvailBalExclList": "NONE",
    "AvailBalInclOdProtection": false,
    "AvailBalInclOdTolerance": false,
    "CardType": 9999,
    "FileRecord": 0,
    "FileType": 0,
    "FileUpdateMethod": 0,
    "NetworkMessageFormat": 9999,
    "PurgeDays": 0,
    "SendBalances": false,
    "SuffixFormat": 0
  },
  "MessageId": "getOnlineFile"
}

getOnlineFileSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

OnlineFileFileRecordintegerOptional

Responses

200

Successful operation.

application/json

post/getOnlineFileSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "OnlineFileFileRecord": 0,
  "SelectableFields": {
    "OnlineFileFields": {
      "FileRecord": true,
      "FileType": true,
      "InstitutionId": true
    }
  }
}

200

Successful operation.

{
  "OnlineFile": {
    "FileRecord": 0,
    "FileType": 0,
    "InstitutionId": null
  },
  "MessageId": "getOnlineFileSelectFields"
}

getOnlineFilePagedList

post

Retrieve OnlineFile 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/getOnlineFilePagedList

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

{
  "OnlineFile": [],
  "Token": null,
  "MessageId": "getOnlineFilePagedList"
}

getOnlineFileListSelectFields

post

Retrieve OnlineFile 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/getOnlineFileListSelectFields

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

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

200

Successful operation.

{
  "OnlineFileList": [],
  "MessageId": "getOnlineFileListSelectFields"
}

searchOnlineFileSelectFields

post

Search OnlineFile 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/searchOnlineFileSelectFields

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

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

200

Successful operation.

{
  "OnlineFileList": [],
  "MessageId": "searchOnlineFileSelectFields"
}

getOnlineFilePagedListSelectFields

post

Retrieve OnlineFile 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/getOnlineFilePagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "OnlineFileFields": {
      "FileRecord": true,
      "FileType": true,
      "InstitutionId": true
    }
  }
}

200

Successful operation.

{
  "OnlineFile": [
    {
      "FileRecord": 0,
      "FileType": 0,
      "InstitutionId": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getOnlineFilePagedListSelectFields"
}

searchOnlineFilePagedSelectFields

post

Search OnlineFile 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/searchOnlineFilePagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "OnlineFileFields": {
      "FileRecord": true,
      "FileType": true,
      "InstitutionId": true
    }
  }
}

200

Successful operation.

{
  "OnlineFile": [
    {
      "FileRecord": 0,
      "FileType": 0,
      "InstitutionId": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchOnlineFilePagedSelectFields"
}

getOnlineFileMgr

post

Retrieve OnlineFileMgr 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/getOnlineFileMgr

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

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

200

Successful operation.

{
  "OnlineFileMgr": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getOnlineFileMgr"
}

getOnlineFileMgrSelectFields

post

Retrieve OnlineFileMgr 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/getOnlineFileMgrSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "OnlineFileMgrFields": {
      "JournalFormat": true,
      "PauseBetweenCycles": true,
      "SaveRejectedMsgsInDialog": true
    }
  }
}

200

Successful operation.

{
  "OnlineFileMgr": {
    "JournalFormat": 0,
    "PauseBetweenCycles": 0,
    "SaveRejectedMsgsInDialog": false
  },
  "MessageId": "getOnlineFileMgrSelectFields"
}

updateOnlineFileByID

post

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

OnlineFileFileRecordintegerOptional

Responses

200

Successful operation.

application/json

post/updateOnlineFileByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineFileFileRecord": "example-value",
  "OnlineFileUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

updateOnlineFileMgrByID

post

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

Responses

200

Successful operation.

application/json

post/updateOnlineFileMgrByID

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

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

200

Successful operation.

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