Note

Perform various operations on note records.

Symitar eDocs References: Coming soon.

Operations

getNote

post
Authorizations
Body
AccountNumberstringOptional
NoteLocatorintegerOptional
Responses
200

Successful operation.

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

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

Successful operation.

{
  "Note": {
    "Code": 1,
    "EnterDate": "2025-11-06",
    "EnterTime": 1,
    "ExpirationDate": "2025-11-06",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "RecordChangeDate": "2025-11-06",
    "Text": [
      {
        "EntryId": 1,
        "Text": "text"
      }
    ],
    "TextLineCount": 1,
    "UserId": 1,
    "VoidFlag": 1,
    "VoidedBy": 1
  }
}

getNoteSelectFields

post
Authorizations
Body
AccountNumberstringOptional
NoteLocatorintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "NoteLocator": 1,
  "SelectableFields": {
    "IncludeAllNoteFields": true,
    "NoteFields": {
      "Code": true,
      "EnterDate": true,
      "EnterTime": true,
      "ExpirationDate": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Text": [
        1
      ],
      "TextLineCount": true,
      "UserId": true,
      "VoidFlag": true,
      "VoidedBy": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Note": {
    "Code": 1,
    "EnterDate": "2025-11-06",
    "EnterTime": 1,
    "ExpirationDate": "2025-11-06",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "RecordChangeDate": "2025-11-06",
    "Text": [
      {
        "EntryId": 1,
        "Text": "text"
      }
    ],
    "TextLineCount": 1,
    "UserId": 1,
    "VoidFlag": 1,
    "VoidedBy": 1
  }
}

getNotePagedList

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

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

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

Successful operation.

{
  "Note": [
    {
      "Code": 1,
      "EnterDate": "2025-11-06",
      "EnterTime": 1,
      "ExpirationDate": "2025-11-06",
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "RecordChangeDate": "2025-11-06",
      "Text": [
        {
          "EntryId": 1,
          "Text": "text"
        }
      ],
      "TextLineCount": 1,
      "UserId": 1,
      "VoidFlag": 1,
      "VoidedBy": 1
    }
  ],
  "Token": "text"
}

getNoteListSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SelectableFields": {
    "IncludeAllNoteFields": true,
    "NoteFields": {
      "Code": true,
      "EnterDate": true,
      "EnterTime": true,
      "ExpirationDate": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Text": [
        1
      ],
      "TextLineCount": true,
      "UserId": true,
      "VoidFlag": true,
      "VoidedBy": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "NoteList": {
    "hasReachedMaximumListSize": true,
    "Note": [
      {
        "Code": 1,
        "EnterDate": "2025-11-06",
        "EnterTime": 1,
        "ExpirationDate": "2025-11-06",
        "Id": "text",
        "IdType": 1,
        "Locator": 1,
        "RecordChangeDate": "2025-11-06",
        "Text": [
          {
            "EntryId": 1,
            "Text": "text"
          }
        ],
        "TextLineCount": 1,
        "UserId": 1,
        "VoidFlag": 1,
        "VoidedBy": 1
      }
    ]
  }
}

searchNoteSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SelectableFields": {
    "IncludeAllNoteFields": true,
    "NoteFields": {
      "Code": true,
      "EnterDate": true,
      "EnterTime": true,
      "ExpirationDate": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Text": [
        1
      ],
      "TextLineCount": true,
      "UserId": true,
      "VoidFlag": true,
      "VoidedBy": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "NoteList": {
    "hasReachedMaximumListSize": true,
    "Note": [
      {
        "Code": 1,
        "EnterDate": "2025-11-06",
        "EnterTime": 1,
        "ExpirationDate": "2025-11-06",
        "Id": "text",
        "IdType": 1,
        "Locator": 1,
        "RecordChangeDate": "2025-11-06",
        "Text": [
          {
            "EntryId": 1,
            "Text": "text"
          }
        ],
        "TextLineCount": 1,
        "UserId": 1,
        "VoidFlag": 1,
        "VoidedBy": 1
      }
    ]
  }
}

getNotePagedListSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllNoteFields": true,
    "NoteFields": {
      "Code": true,
      "EnterDate": true,
      "EnterTime": true,
      "ExpirationDate": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Text": [
        1
      ],
      "TextLineCount": true,
      "UserId": true,
      "VoidFlag": true,
      "VoidedBy": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Note": [
    {
      "Code": 1,
      "EnterDate": "2025-11-06",
      "EnterTime": 1,
      "ExpirationDate": "2025-11-06",
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "RecordChangeDate": "2025-11-06",
      "Text": [
        {
          "EntryId": 1,
          "Text": "text"
        }
      ],
      "TextLineCount": 1,
      "UserId": 1,
      "VoidFlag": 1,
      "VoidedBy": 1
    }
  ],
  "Token": "text"
}

searchNotePagedSelectFields

post
Authorizations
Body
AccountNumberstringOptional
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllNoteFields": true,
    "NoteFields": {
      "Code": true,
      "EnterDate": true,
      "EnterTime": true,
      "ExpirationDate": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Text": [
        1
      ],
      "TextLineCount": true,
      "UserId": true,
      "VoidFlag": true,
      "VoidedBy": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Note": [
    {
      "Code": 1,
      "EnterDate": "2025-11-06",
      "EnterTime": 1,
      "ExpirationDate": "2025-11-06",
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "RecordChangeDate": "2025-11-06",
      "Text": [
        {
          "EntryId": 1,
          "Text": "text"
        }
      ],
      "TextLineCount": 1,
      "UserId": 1,
      "VoidFlag": 1,
      "VoidedBy": 1
    }
  ],
  "Token": "text"
}

updateNoteByID

post
Authorizations
Body
NoteLocatorintegerOptional
AccountNumberstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "NoteLocator": 1,
  "NoteUpdatableFields": {
    "Code": 1,
    "EnterDate": "2025-11-06",
    "EnterTime": 1,
    "ExpirationDate": "2025-11-06",
    "Text": [
      {
        "EntryId": 1,
        "Text": "text"
      }
    ],
    "UserId": 1,
    "VoidFlag": 1,
    "VoidedBy": 1
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

createNote

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "NoteCreatableFields": {
    "Code": 1,
    "EnterDate": "2025-11-06",
    "EnterTime": 1,
    "ExpirationDate": "2025-11-06",
    "Text": [
      {
        "EntryId": 1,
        "Text": "text"
      }
    ],
    "UserId": 1,
    "VoidFlag": 1,
    "VoidedBy": 1
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "NoteLocator": 1
}

deleteNote

post
Authorizations
Body
AccountNumberstringOptional
NoteLocatorintegerOptional
Responses
200

Successful operation.

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

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

Successful operation.

{
  "nxAttributes": {}
}
PreviousNameNextPledge

Last updated

Was this helpful?