Search for Client Notes

Searches for client notes.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • pageNointeger

    Default: 1

  • pageSizeinteger

    Default: 100

  • sortNamestring

    Default: note.id

  • isDescendingOrderboolean

  • queryStringstring

Responses

  • resultsarray

  • totalResultsinteger

  • orderBystring

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • nextPageNointeger

  • previousPageNointeger

  • descendingOrderboolean

Response Samples

{
  "results": [
    {
      "id": 26,
      "subject": "Demo Client Note",
      "description": "Client note for Logix",
      "createdTime": "2016-03-25T09:54:52+0000",
      "updatedTime": "2016-03-25T09:54:52+0000",
      "expiryTime": "",
      "createdBy": {
        "id": "USR0000000001",
        "loginName": "superadmin",
        "lastName": "Admin",
        "firstName": "Super",
        "email": "james.hudson@gmail.com",
        "changePassword": false
      }
    },
    {
      "id": 25,
      "subject": "AXC Client Note",
      "description": "Client Note for AXC",
      "createdTime": "2016-03-25T09:54:08+0000",
      "updatedTime": "2016-03-25T09:54:08+0000",
      "expiryTime": "",
      "createdBy": {
        "id": "USR0000000001",
        "loginName": "John.Smith",
        "lastName": "Smith",
        "firstName": "John",
        "email": "john.smith@gmail.com",
        "changePassword": false
      }
    },
    {
      "id": 24,
      "subject": "Client Notes",
      "description": "Notes for Client in location SJ",
      "createdTime": "2016-03-25T09:43:21+0000",
      "updatedTime": "2016-03-25T09:43:21+0000",
      "expiryTime": "",
      "createdBy": {
        "id": "USR0000000001",
        "loginName": "John.Smith",
        "lastName": "Smith",
        "firstName": "John",
        "email": "john.smith@gmail.com",
        "changePassword": false
      }
    }
  ],
  "totalResults": 3,
  "orderBy": "note.id",
  "pageNo": 1,
  "pageSize": 3,
  "totalPages": 3,
  "nextPage": true,
  "nextPageNo": 2,
  "previousPageNo": 0,
  "descendingOrder": true
}