Skip to content
NexumAPI Docs

Notice⁠

Perform various operations for Symitar parameters.

Operations⁠

getNoticeSelectFields⁠

POST

Execute the persistent ParameterService getNoticeSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
NoticeNoticeTypeintegeroptional
NoticeNoticeDescrTypeintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getNoticeSelectFields
POST /nexum/627/persistent/parameter/getNoticeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "NoticeNoticeType": 0,
  "NoticeNoticeDescrType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllNoticeFields": true,
    "NoticeFields": {
      "DaysBetweenNotices": [
        0
      ],
      "Description": true,
      "Line1": [
        0
      ],
      "Line2": [
        0
      ],
      "Line3": [
        0
      ],
      "Line4": [
        0
      ],
      "NegativeInfoMessage": [
        0
      ],
      "NegativeInfoPrintPosition": true,
      "NoticeDescrType": true,
      "NoticeType": true,
      "UseWarningGraceDays": true,
      "WarningGraceDays": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getNoticePagedListSelectFields⁠

POST

Execute the persistent ParameterService getNoticePagedListSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getNoticePagedListSelectFields
POST /nexum/627/persistent/parameter/getNoticePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllNoticeFields": true,
    "NoticeFields": {
      "DaysBetweenNotices": [
        0
      ],
      "Description": true,
      "Line1": [
        0
      ],
      "Line2": [
        0
      ],
      "Line3": [
        0
      ],
      "Line4": [
        0
      ],
      "NegativeInfoMessage": [
        0
      ],
      "NegativeInfoPrintPosition": true,
      "NoticeDescrType": true,
      "NoticeType": true,
      "UseWarningGraceDays": true,
      "WarningGraceDays": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchNoticePagedSelectFields⁠

POST

Execute the persistent ParameterService searchNoticePagedSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/searchNoticePagedSelectFields
POST /nexum/627/persistent/parameter/searchNoticePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllNoticeFields": true,
    "NoticeFields": {
      "DaysBetweenNotices": [
        0
      ],
      "Description": true,
      "Line1": [
        0
      ],
      "Line2": [
        0
      ],
      "Line3": [
        0
      ],
      "Line4": [
        0
      ],
      "NegativeInfoMessage": [
        0
      ],
      "NegativeInfoPrintPosition": true,
      "NoticeDescrType": true,
      "NoticeType": true,
      "UseWarningGraceDays": true,
      "WarningGraceDays": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateNoticeByID⁠

POST

Execute the persistent ParameterService updateNoticeByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
NoticeNoticeTypeintegeroptional
NoticeNoticeDescrTypeintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/updateNoticeByID
POST /nexum/627/persistent/parameter/updateNoticeByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "NoticeNoticeType": 0,
  "NoticeNoticeDescrType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "NoticeFields": {
    "DaysBetweenNotices": [
      {
        "EntryId": 0,
        "DaysBetweenNotices": 0
      }
    ],
    "Description": "string",
    "Line1": [
      {
        "EntryId": 0,
        "Line1": "string"
      }
    ],
    "Line2": [
      {
        "EntryId": 0,
        "Line2": "string"
      }
    ],
    "Line3": [
      {
        "EntryId": 0,
        "Line3": "string"
      }
    ],
    "Line4": [
      {
        "EntryId": 0,
        "Line4": "string"
      }
    ],
    "NegativeInfoMessage": [
      {
        "EntryId": 0,
        "NegativeInfoMessage": 0
      }
    ],
    "NegativeInfoPrintPosition": 0,
    "NoticeDescrType": 0,
    "NoticeType": 0,
    "UseWarningGraceDays": 0,
    "WarningGraceDays": 0
  },
  "nxAttributes": {
    "customFields": {}
  }
}