Endpoint
/api/v2/tenants/{tenantId}/notes/search
Path Parameters
tenantId
string

Describes the clientId or mspId of the tenant

Query Parameters
pageNo
integer

pageSize
integer

sortName
string

isDescendingOrder
boolean

queryString
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

nextPageNo
integer

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.createdBy
results.createdTime
results.description
Summary describing the note.
results.expiryDateType
Type of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.
results.expiryTime
Date and time on which the note expires. This field is mandatory if expiryDateType is set as 2.
results.id
results.startTime
Date and time from which the note is valid. This is applicable only if expiryDateType is set as 2.
results.subject
Subject of note.
results.updatedTime
totalPages
integer

totalResults
integer

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