List Watchdog


Description

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

Authentication

Requires HTTP BASIC authentication. The authenticating user must have ROLE_LOAD_PERMITTED assigned.

HTTP Methods

Accepts GET requests.

URI

/api/creditor/{creditorUuid}/user/{userUuid}/watchdogs

Path Variables

Name Required/Optional Description Validation
creditorUuid required The UUID of the creditor in the system Creditor UUID should exist in the system
userUuid required The UUID of the user in the system User UUID should exist in the system

HTTP Parameters

Name Required/Optional Description Validation
name optional The watchdog name Length should not be greater than 100 character
recipientName optional Name of the recipient who created the WatchDog Name should not exceed 100 characters
recipientEmail optional Email of the recipient on which WatchDog alerts needs to be sent Email should be valid and should not exceed 100 characters
recipientCompany optional The company name of the user for which the WatchDog is set for The company name should not exceed 100 characters
firstResult optional The index of the first result to return Must be 0 or greater
maxResults optional The maximum number of results to return Default is 100. Max is 1000.

Curl Example

Request

curl -u apiuser:test "https://www.factorsnetwork.com/api/creditor/96575125-5fa6-44f5-9e37-afbb5f56b737/users/2cfd1367-4f19-4cc5-a6e6-8b1d53e52320/watchdogs?firstResult=0&maxResults=2"

Response

{
  "watchdogs" : [ {
    "id" : "8d5503f1-8cf4-433d-96e4-844c7ea0697c",
    "specificCompany" : "ABC Company",
    "originCity" : " LAS VEGAS",
    "originState" : "NV",
    "originRadius" : 100,
    "destinationCity" : "",
    "destinationState" : "",
    "destinationRadius" : 100,
    "fromDate" : "2016-06-27",
    "toDate" : "2016-07-27",
    "fromWeight" : null,
    "toWeight" : null,
    "equipment" : "All Types",
    "volume" : "Both",
    "fromRate" : null,
    "toRate" : null,
    "expiryDays" : 7,
    "expiryDate" : "2016-07-04",
    "status" : "Active",
    "name" : "watchdog1",
    "owner" : "Fname Lname",
    "recipientName" : "testUser",
    "recipientEmail" : "testUser@xyz.in",
    "recipientCompany" : "Test Company",
    "customMessage" : "Test message"
  }, {
    "id" : "395b42b6-5849-4278-a0ea-8fa9190691ad",
    "specificCompany" : null,
    "originCity" : "LAYTON",
    "originState" : "UT",
    "originRadius" : 100,
    "destinationCity" : null,
    "destinationState" : null,
    "destinationRadius" : 100,
    "fromDate" : null,
    "toDate" : null,
    "fromWeight" : null,
    "toWeight" : null,
    "equipment" : null,
    "volume" : "Both",
    "fromRate" : null,
    "toRate" : null,
    "expiryDays" : 7,
    "expiryDate" : "2016-07-04",
    "status" : "Active",
    "name" : "John's Load",
    "owner" : "Fname Lname",
    "recipientName" : "testUser",
    "recipientEmail" : "testUser@xyz.in",
    "recipientCompany" : "Test Company",
    "customMessage" : "Test message"
  } ],
  "totalRecords" : 20
}

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