Get Carrier Monitoring


Description

This method is used to get Carrier Monitoring data.

Authentication

Requires HTTP BASIC authentication.

HTTP Methods

Accepts GET requests.

URI

/api/2.0/creditors/{creditor}/carrier_monitoring/watchlist

Path Variables

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

HTTP Parameters

No HTTP parameters.

Curl Example

Request

curl -k -u apiuser:test -X GET "https://www.factorsnetwork.com/api/2.0/creditors/5ed02be3-7284-41ec-89da-09d665ad43e9/carrier_monitoring/watchlist"
						

Response

{
  "carrierWatchListResponse" : [ {
    "mcNumber" : "71",
    "dotNumber" : "7144",
    "companyName" : "MOVSON LLC",
    "alerts" : 2,
    "matches" : 0,
    "dateUpdated" : "09/02/2014"
  }, {
    "mcNumber" : "72",
    "dotNumber" : "79981",
    "companyName" : "A H STATES LLC",
    "alerts" : 0,
    "matches" : 12,
    "dateUpdated" : "06/30/2014"
  } ],
  "totalRecords" : 2
}

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