List Messages


Description

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

Authentication

Requires HTTP BASIC authentication.

HTTP Methods

Accepts GET requests.

URI

/api/debtors/{uuid}/messages.json

Path Variables

Name Required/Optional Description Validation
uuid 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/ebb16383-2121-d11d-dd33-869ffac113be/messages.json

Response

{
  "messages" : [ {
    "uuid" : "50ea89a4-2121-d11d-dd33-869ffac113be",
    "debtorUuid" : "ebb16383-2121-d11d-dd33-869ffac113be",
    "toCreditorUuid" : "ff5ac510-2121-d11d-dd33-869ffac113be",
    "fromCreditorUuid" : "24b3602c-2121-d11d-dd33-869ffac113be",
    "subject" : "Test",
    "message" : "Test",
    "creationDate" : "2012-08-22 14:11:02.916"
  } ],
  "totalRecords" : 1
}

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