Notice

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getNotice

post

Retrieve notice information

Authorizations
Body
NoticeNoticeTypeintegerOptional
NoticeNoticeDescrTypeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NoticeNoticeType": 1,
  "NoticeNoticeDescrType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Notice": {
    "DaysBetweenNotices": [
      {
        "EntryId": 1,
        "DaysBetweenNotices": 1
      }
    ],
    "Description": "text",
    "Line1": [
      {
        "EntryId": 1,
        "Line1": "text"
      }
    ],
    "Line2": [
      {
        "EntryId": 1,
        "Line2": "text"
      }
    ],
    "Line3": [
      {
        "EntryId": 1,
        "Line3": "text"
      }
    ],
    "Line4": [
      {
        "EntryId": 1,
        "Line4": "text"
      }
    ],
    "NegativeInfoMessage": [
      {
        "EntryId": 1,
        "NegativeInfoMessage": 1
      }
    ],
    "NegativeInfoPrintPosition": 1,
    "NoticeDescrType": 1,
    "NoticeType": 1,
    "UseWarningGraceDays": 1,
    "WarningGraceDays": 1
  }
}

getNoticeSelectFields

post

Retrieve notice select fields

Authorizations
Body
NoticeNoticeTypeintegerOptional
NoticeNoticeDescrTypeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NoticeNoticeType": 1,
  "NoticeNoticeDescrType": 1,
  "SelectableFields": {
    "IncludeAllNoticeFields": true,
    "NoticeFields": {
      "DaysBetweenNotices": [
        1
      ],
      "Description": true,
      "Line1": [
        1
      ],
      "Line2": [
        1
      ],
      "Line3": [
        1
      ],
      "Line4": [
        1
      ],
      "NegativeInfoMessage": [
        1
      ],
      "NegativeInfoPrintPosition": true,
      "NoticeDescrType": true,
      "NoticeType": true,
      "UseWarningGraceDays": true,
      "WarningGraceDays": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Notice": {
    "DaysBetweenNotices": [
      {
        "EntryId": 1,
        "DaysBetweenNotices": 1
      }
    ],
    "Description": "text",
    "Line1": [
      {
        "EntryId": 1,
        "Line1": "text"
      }
    ],
    "Line2": [
      {
        "EntryId": 1,
        "Line2": "text"
      }
    ],
    "Line3": [
      {
        "EntryId": 1,
        "Line3": "text"
      }
    ],
    "Line4": [
      {
        "EntryId": 1,
        "Line4": "text"
      }
    ],
    "NegativeInfoMessage": [
      {
        "EntryId": 1,
        "NegativeInfoMessage": 1
      }
    ],
    "NegativeInfoPrintPosition": 1,
    "NoticeDescrType": 1,
    "NoticeType": 1,
    "UseWarningGraceDays": 1,
    "WarningGraceDays": 1
  }
}

getNoticePagedList

post

Retrieve paged list of notices

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getNoticePagedList
POST /nexum/627/2022.01/parameter/getNoticePagedList 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.

{
  "Notice": [
    {
      "DaysBetweenNotices": [
        {
          "EntryId": 1,
          "DaysBetweenNotices": 1
        }
      ],
      "Description": "text",
      "Line1": [
        {
          "EntryId": 1,
          "Line1": "text"
        }
      ],
      "Line2": [
        {
          "EntryId": 1,
          "Line2": "text"
        }
      ],
      "Line3": [
        {
          "EntryId": 1,
          "Line3": "text"
        }
      ],
      "Line4": [
        {
          "EntryId": 1,
          "Line4": "text"
        }
      ],
      "NegativeInfoMessage": [
        {
          "EntryId": 1,
          "NegativeInfoMessage": 1
        }
      ],
      "NegativeInfoPrintPosition": 1,
      "NoticeDescrType": 1,
      "NoticeType": 1,
      "UseWarningGraceDays": 1,
      "WarningGraceDays": 1
    }
  ],
  "Token": "text"
}

getNoticeListSelectFields

post

Retrieve notice list select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllNoticeFields": true,
    "NoticeFields": {
      "DaysBetweenNotices": [
        1
      ],
      "Description": true,
      "Line1": [
        1
      ],
      "Line2": [
        1
      ],
      "Line3": [
        1
      ],
      "Line4": [
        1
      ],
      "NegativeInfoMessage": [
        1
      ],
      "NegativeInfoPrintPosition": true,
      "NoticeDescrType": true,
      "NoticeType": true,
      "UseWarningGraceDays": true,
      "WarningGraceDays": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "NoticeList": {
    "hasReachedMaximumListSize": true,
    "Notice": [
      {
        "DaysBetweenNotices": [
          {
            "EntryId": 1,
            "DaysBetweenNotices": 1
          }
        ],
        "Description": "text",
        "Line1": [
          {
            "EntryId": 1,
            "Line1": "text"
          }
        ],
        "Line2": [
          {
            "EntryId": 1,
            "Line2": "text"
          }
        ],
        "Line3": [
          {
            "EntryId": 1,
            "Line3": "text"
          }
        ],
        "Line4": [
          {
            "EntryId": 1,
            "Line4": "text"
          }
        ],
        "NegativeInfoMessage": [
          {
            "EntryId": 1,
            "NegativeInfoMessage": 1
          }
        ],
        "NegativeInfoPrintPosition": 1,
        "NoticeDescrType": 1,
        "NoticeType": 1,
        "UseWarningGraceDays": 1,
        "WarningGraceDays": 1
      }
    ]
  }
}

searchNoticeSelectFields

post

Retrieve a list of select fields for searching by notice information.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllNoticeFields": true,
    "NoticeFields": {
      "DaysBetweenNotices": [
        1
      ],
      "Description": true,
      "Line1": [
        1
      ],
      "Line2": [
        1
      ],
      "Line3": [
        1
      ],
      "Line4": [
        1
      ],
      "NegativeInfoMessage": [
        1
      ],
      "NegativeInfoPrintPosition": true,
      "NoticeDescrType": true,
      "NoticeType": true,
      "UseWarningGraceDays": true,
      "WarningGraceDays": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "NoticeList": {
    "hasReachedMaximumListSize": true,
    "Notice": [
      {
        "DaysBetweenNotices": [
          {
            "EntryId": 1,
            "DaysBetweenNotices": 1
          }
        ],
        "Description": "text",
        "Line1": [
          {
            "EntryId": 1,
            "Line1": "text"
          }
        ],
        "Line2": [
          {
            "EntryId": 1,
            "Line2": "text"
          }
        ],
        "Line3": [
          {
            "EntryId": 1,
            "Line3": "text"
          }
        ],
        "Line4": [
          {
            "EntryId": 1,
            "Line4": "text"
          }
        ],
        "NegativeInfoMessage": [
          {
            "EntryId": 1,
            "NegativeInfoMessage": 1
          }
        ],
        "NegativeInfoPrintPosition": 1,
        "NoticeDescrType": 1,
        "NoticeType": 1,
        "UseWarningGraceDays": 1,
        "WarningGraceDays": 1
      }
    ]
  }
}

getNoticePagedListSelectFields

post

Retrieve paged list select fields of notices

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllNoticeFields": true,
    "NoticeFields": {
      "DaysBetweenNotices": [
        1
      ],
      "Description": true,
      "Line1": [
        1
      ],
      "Line2": [
        1
      ],
      "Line3": [
        1
      ],
      "Line4": [
        1
      ],
      "NegativeInfoMessage": [
        1
      ],
      "NegativeInfoPrintPosition": true,
      "NoticeDescrType": true,
      "NoticeType": true,
      "UseWarningGraceDays": true,
      "WarningGraceDays": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Notice": [
    {
      "DaysBetweenNotices": [
        {
          "EntryId": 1,
          "DaysBetweenNotices": 1
        }
      ],
      "Description": "text",
      "Line1": [
        {
          "EntryId": 1,
          "Line1": "text"
        }
      ],
      "Line2": [
        {
          "EntryId": 1,
          "Line2": "text"
        }
      ],
      "Line3": [
        {
          "EntryId": 1,
          "Line3": "text"
        }
      ],
      "Line4": [
        {
          "EntryId": 1,
          "Line4": "text"
        }
      ],
      "NegativeInfoMessage": [
        {
          "EntryId": 1,
          "NegativeInfoMessage": 1
        }
      ],
      "NegativeInfoPrintPosition": 1,
      "NoticeDescrType": 1,
      "NoticeType": 1,
      "UseWarningGraceDays": 1,
      "WarningGraceDays": 1
    }
  ],
  "Token": "text"
}

searchNoticePagedSelectFields

post

Retrieve a list of paged select fields for searching by notice information.

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllNoticeFields": true,
    "NoticeFields": {
      "DaysBetweenNotices": [
        1
      ],
      "Description": true,
      "Line1": [
        1
      ],
      "Line2": [
        1
      ],
      "Line3": [
        1
      ],
      "Line4": [
        1
      ],
      "NegativeInfoMessage": [
        1
      ],
      "NegativeInfoPrintPosition": true,
      "NoticeDescrType": true,
      "NoticeType": true,
      "UseWarningGraceDays": true,
      "WarningGraceDays": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Notice": [
    {
      "DaysBetweenNotices": [
        {
          "EntryId": 1,
          "DaysBetweenNotices": 1
        }
      ],
      "Description": "text",
      "Line1": [
        {
          "EntryId": 1,
          "Line1": "text"
        }
      ],
      "Line2": [
        {
          "EntryId": 1,
          "Line2": "text"
        }
      ],
      "Line3": [
        {
          "EntryId": 1,
          "Line3": "text"
        }
      ],
      "Line4": [
        {
          "EntryId": 1,
          "Line4": "text"
        }
      ],
      "NegativeInfoMessage": [
        {
          "EntryId": 1,
          "NegativeInfoMessage": 1
        }
      ],
      "NegativeInfoPrintPosition": 1,
      "NoticeDescrType": 1,
      "NoticeType": 1,
      "UseWarningGraceDays": 1,
      "WarningGraceDays": 1
    }
  ],
  "Token": "text"
}

updateNoticeByID

post

Update notices by ID

Authorizations
Body
NoticeNoticeTypeintegerOptional
NoticeNoticeDescrTypeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NoticeNoticeType": 1,
  "NoticeNoticeDescrType": 1,
  "NoticeUpdatableFields": {
    "DaysBetweenNotices": [
      {
        "EntryId": 1,
        "DaysBetweenNotices": 1
      }
    ],
    "Description": "text",
    "Line1": [
      {
        "EntryId": 1,
        "Line1": "text"
      }
    ],
    "Line2": [
      {
        "EntryId": 1,
        "Line2": "text"
      }
    ],
    "Line3": [
      {
        "EntryId": 1,
        "Line3": "text"
      }
    ],
    "Line4": [
      {
        "EntryId": 1,
        "Line4": "text"
      }
    ],
    "NegativeInfoMessage": [
      {
        "EntryId": 1,
        "NegativeInfoMessage": 1
      }
    ],
    "NegativeInfoPrintPosition": 1,
    "UseWarningGraceDays": 1,
    "WarningGraceDays": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?