Notice

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getNotice

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NoticeNoticeTypeintegerOptional

NoticeNoticeDescrTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getNotice

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "NoticeNoticeType": 1,
  "NoticeNoticeDescrType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Notice": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getNotice"
}

getNoticeSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NoticeNoticeTypeintegerOptional

NoticeNoticeDescrTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getNoticeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "NoticeNoticeType": 0,
  "NoticeNoticeDescrType": 0,
  "SelectableFields": {
    "NoticeFields": {
      "NoticeType": true,
      "NoticeDescrType": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "Notice": {
    "Description": "DQ Notice Type 00",
    "NoticeDescrType": 0,
    "NoticeType": 0
  },
  "MessageId": "getNoticeSelectFields"
}

getNoticePagedList

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getNoticePagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Notice": [],
  "Token": null,
  "MessageId": "getNoticePagedList"
}

getNoticeListSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getNoticeListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllNoticeFields": true
  }
}

200

Successful operation.

{
  "NoticeList": [],
  "MessageId": "getNoticeListSelectFields"
}

searchNoticeSelectFields

post

Search Notice parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/searchNoticeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllNoticeFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "NoticeList": [],
  "MessageId": "searchNoticeSelectFields"
}

getNoticePagedListSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getNoticePagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "NoticeFields": {
      "NoticeType": true,
      "NoticeDescrType": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "Notice": [
    {
      "Description": "DQ Notice Type 00",
      "NoticeDescrType": 0,
      "NoticeType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getNoticePagedListSelectFields"
}

searchNoticePagedSelectFields

post

Search Notice parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchNoticePagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "NoticeFields": {
      "NoticeType": true,
      "NoticeDescrType": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "Notice": [
    {
      "Description": "DQ Notice Type 00",
      "NoticeDescrType": 0,
      "NoticeType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchNoticePagedSelectFields"
}

updateNoticeByID

post

Update Notice parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NoticeNoticeTypeintegerOptional

NoticeNoticeDescrTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateNoticeByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "NoticeNoticeType": 1,
  "NoticeNoticeDescrType": 1,
  "NoticeUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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