Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Warnings

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getWarnings

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
WarningsWarningNumberintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "Warnings": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getWarnings"
}

getWarningsSelectFields

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
WarningsWarningNumberintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "WarningsWarningNumber": 1,
  "SelectableFields": {
    "IncludeAllWarningsFields": true
  }
}
200

Successful operation.

{
  "Warnings": {
    "DisplayWarninginAcctMgr": true,
    "DisplayWarninginTlrTrn": true,
    "WarnDescription": "NO BATCH POSTING ALLOWED",
    "WarnFmPriv": 0,
    "WarnIqPriv": 0,
    "WarnTrPriv": 0,
    "WarningNumber": 1
  },
  "MessageId": "getWarningsSelectFields"
}

getWarningsPagedList

post

Retrieve Warnings 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/getWarningsPagedList
POST /nexum/627/2022.01/parameter/getWarningsPagedList 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.

{
  "Warnings": [],
  "Token": null,
  "MessageId": "getWarningsPagedList"
}

getWarningsListSelectFields

post

Retrieve Warnings 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/getWarningsListSelectFields
POST /nexum/627/2022.01/parameter/getWarningsListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

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

Successful operation.

{
  "WarningsList": [],
  "MessageId": "getWarningsListSelectFields"
}

searchWarningsSelectFields

post

Search Warnings 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/searchWarningsSelectFields
POST /nexum/627/2022.01/parameter/searchWarningsSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 229

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

Successful operation.

{
  "WarningsList": [],
  "MessageId": "searchWarningsSelectFields"
}

getWarningsPagedListSelectFields

post

Retrieve Warnings 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/getWarningsPagedListSelectFields
POST /nexum/627/2022.01/parameter/getWarningsPagedListSelectFields 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"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllWarningsFields": true
  }
}
200

Successful operation.

{
  "Warnings": [
    {
      "DisplayWarninginAcctMgr": true,
      "DisplayWarninginTlrTrn": true,
      "WarnDescription": "NO BATCH POSTING ALLOWED",
      "WarningNumber": 1
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getWarningsPagedListSelectFields"
}

searchWarningsPagedSelectFields

post

Search Warnings 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/searchWarningsPagedSelectFields
POST /nexum/627/2022.01/parameter/searchWarningsPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 281

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

Successful operation.

{
  "Warnings": [
    {
      "DisplayWarninginAcctMgr": true,
      "DisplayWarninginTlrTrn": true,
      "WarnDescription": "NO BATCH POSTING ALLOWED",
      "WarningNumber": 1
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchWarningsPagedSelectFields"
}

updateWarningsByID

post

Update Warnings 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
WarningsWarningNumberintegerOptional
Responses
200

Successful operation.

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

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

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateWarningsByID"
}
PreviousUserTrackingType
NextWdFee

Last updated

Was this helpful?