List Notes


Description

This method is used to search and retrieve a list of notes and their data.

Authentication

Requires HTTP BASIC authentication.

HTTP Methods

Accepts GET requests.

URI

/api/debtors/{duuid}/notes.json

Path Variables

Name Required/Optional Description Validation
duuid required The UUID of the debtor Debtor UUID should exist in the system.

HTTP Parameters

No HTTP parameters.

Curl Example

Request

curl -u apiuser:test https://www.factorsnetwork.com/api/debtors/645d5f2e-2121-d11d-dd33-869ffac113be/notes.json

Response

{
  "notes" : [ {
    "uuid" : "e6aaa036-2121-d11d-dd33-16d56d6169af",
    "debtorUuid" : "645d5f2e-2121-d11d-dd33-869ffac113be",
    "creditorUuid" : "24b3602c-2121-d11d-dd33-869ffac113be",
    "complaint" : "test",
    "noteType" : "NON_PAYMENT_COMPLAINT",
    "creationDate" : "2012-12-21 14:24:24"
  }, {
    "uuid" : "9d775bfb-2121-d11d-dd33-869ffac113be",
    "debtorUuid" : "645d5f2e-2121-d11d-dd33-869ffac113be",
    "creditorUuid" : "24b3602c-2121-d11d-dd33-869ffac113be",
    "complaint" : "This is my complaint",
    "noteType" : "NON_PAYMENT_COMPLAINT",
    "creationDate" : "2011-04-19 10:49:01"
  } ],
  "totalRecords" : 2
}

Note: Responses will not be pretty printed when using the API, but have been formatted here for documentation purposes.