Comment

Perform various operations on comment records.

Symitar eDocs References: Coming soon.

Operations

getCommentSelectFields

post
Authorizations
Body
AccountNumberstringOptional
CommentLocatorintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/getCommentSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "CommentLocator": 1,
  "SelectableFields": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "EffectiveDate": true,
      "ExpirationDate": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Text": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Comment": {
    "EffectiveDate": "2025-06-23",
    "ExpirationDate": "2025-06-23",
    "Locator": 1,
    "RecordChangeDate": "2025-06-23",
    "Text": "text",
    "Type": 1
  }
}

getCommentPagedListSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/getCommentPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 432

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "EffectiveDate": true,
      "ExpirationDate": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Text": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Comment": [
    {
      "EffectiveDate": "2025-06-23",
      "ExpirationDate": "2025-06-23",
      "Locator": 1,
      "RecordChangeDate": "2025-06-23",
      "Text": "text",
      "Type": 1
    }
  ],
  "Token": "text"
}

searchCommentPagedSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/searchCommentPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 464

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "EffectiveDate": true,
      "ExpirationDate": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Text": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Comment": [
    {
      "EffectiveDate": "2025-06-23",
      "ExpirationDate": "2025-06-23",
      "Locator": 1,
      "RecordChangeDate": "2025-06-23",
      "Text": "text",
      "Type": 1
    }
  ],
  "Token": "text"
}

updateCommentByID

post
Authorizations
Body
AccountNumberstringOptional
CommentLocatorintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/updateCommentByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "CommentLocator": 1,
  "CommentFields": {
    "EffectiveDate": "2025-06-23",
    "ExpirationDate": "2025-06-23",
    "Locator": 1,
    "RecordChangeDate": "2025-06-23",
    "Text": "text",
    "Type": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

createComment

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/createComment HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 306

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "CommentFields": {
    "EffectiveDate": "2025-06-23",
    "ExpirationDate": "2025-06-23",
    "Locator": 1,
    "RecordChangeDate": "2025-06-23",
    "Text": "text",
    "Type": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CommentLocator": 1
}

deleteComment

post
Authorizations
Body
AccountNumberstringOptional
CommentLocatorintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/deleteComment HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "CommentLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "nxAttributes": {}
}
PreviousupdateCardNextCpWorkCard

Last updated

Was this helpful?