Note

Perform various operations on note records.

Symitar eDocs References: Coming soon.

Operations

getNoteSelectFields

post

Authorizations

Body

AccountNumberstringOptional

NoteLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/getNoteSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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-05-19",
    "EnterTime": 1,
    "ExpirationDate": "2025-05-19",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "RecordChangeDate": "2025-05-19",
    "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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/getNotePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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-05-19",
      "EnterTime": 1,
      "ExpirationDate": "2025-05-19",
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "RecordChangeDate": "2025-05-19",
      "Text": [
        {
          "EntryId": 1,
          "Text": "text"
        }
      ],
      "TextLineCount": 1,
      "UserId": 1,
      "VoidFlag": 1,
      "VoidedBy": 1
    }
  ],
  "Token": "text"
}

searchNotePagedSelectFields

post

Authorizations

Body

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/searchNotePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 561

{
  "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
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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

updateNoteByID

post

Authorizations

Body

AccountNumberstringOptional

NoteLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/updateNoteByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "NoteLocator": 1,
  "NoteFields": {
    "Code": 1,
    "EnterDate": "2025-05-19",
    "EnterTime": 1,
    "ExpirationDate": "2025-05-19",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "RecordChangeDate": "2025-05-19",
    "Text": [
      {
        "EntryId": 1,
        "Text": "text"
      }
    ],
    "TextLineCount": 1,
    "UserId": 1,
    "VoidFlag": 1,
    "VoidedBy": 1
  },
  "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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/createNote HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 414

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

200

Successful operation.

{
  "NoteLocator": 1
}

deleteNote

post

Authorizations

Body

AccountNumberstringOptional

NoteLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/deleteNote HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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": {}
}