Last updated April 23, 2008. Please refer to the Change Log for details.
Welcome to the developer documentation for the Carrier411 web services API.
Carrier411 web services provides developers with direct access to our robust technology platform, providing the ability to enable and enhance your transportation management software. We innovate for you, so you can innovate your business by running queries on structured data in real time.
Are You Ready for the Ultimate in Real-Time Integration?
Carrier411 now provides a web services interface that uses SOAP protocols as defined by SOAP Specifications available on the W3C website.
Please refer to specifications on the W3C website to learn how SOAP works, and how your IT department or software vendor can set up your brokerage software to integrate with Carrier411 using our SOAP web services.
Web services are essentially just a way to send data to and receive data from other systems via standard XML interfaces, typically using the SOAP protocol. Using web services is similar to submitting an HTTP request from one server to another, except that data is in an XML format.
The Benefits of Using Carrier411 Web Services
Web services enables quick and easy integration with Carrier411 directly from your server and brokerage software, sort of behind the scenes, without interacting through our website. In simple terms, your server communicates with our server.
Using a series of functions described below, our web services provide the ability for your system to make live remote procedure calls directly to our database of over 520,000 companies, which includes up-to-date information for every motor carrier registered with the FMCSA, including those applying for new carrier authority.
So whether you are adding a new carrier or loading an existing carrier, your brokerage software can request and retrieve instant information for any MC, FF or MX number, including the insurance, operating authority, safety ratings, SafeStat SEA scores and census data needed to keep your software database up-to-date automatically.
When using your software, information from Carrier411 can be retrieved, stored and displayed. And as a result, business rules can be set in your software to determine how the data affects what you do, like preventing a carrier with no active authority or an unsatisfactory safety rating from being loaded. Again, this can be done automatically.
Web services also provides the ability for your software to interact directly with your Carrier411 account, so you can add and remove carriers from your monitoring list, and get a complete list of changes for all your registered carriers.
If you monitor thousands of carriers, then you know how time-consuming the process of manually updating records in your software can be. And consider the consequences if you overlook updating certain carriers. Without a doubt, real-time integration using Carrier411 web services improves efficiency and makes all that tedious, painstaking work a thing of the past.
Want to Start Using Carrier411 Web Services?
If you have any questions, or if you would like web services enabled for your account, please call us today at (888) 411-9661. The cost to use our web services interface is an additional $99.00 per month and requires an active Carrier411 account.
Change Log - Last Updated April 23, 2008
| Change Log |
Description |
| February 8, 2007 |
Added wsGetAllSafeStat function. |
| February 9, 2007 |
Added wsGetAllSafety function. |
| February 20, 2007 |
Added FMCSAAPPLICANTID element to data structures returned by wsGetCompany, wsGetInsAuth and wsGetSafeStat functions. |
| March 19, 2007 |
Added wsGetInsPols function. |
| March 20, 2007 |
Added wsGet411Status function. |
| March 29, 2007 |
Added wsGetDocketList function. |
| March 30, 2007 |
Implemented gzip compression capability on web services application server to return gzip compressed data whenever possible, resulting in dramatically decreased transmission times and improved performance for larger requests. |
| April 29, 2007 |
Added wsGetAllAuth function. |
| May 16, 2007 |
Added wsInsAuthDateTime function. |
| February 12, 2008 |
Added wsGetSafetyUpdates function. |
| April 23, 2008 |
Retired wsGetSafety function, which is no longer available. Instead use wsGetSafetyUpdates to obtain carrier safety ratings for registered companies being monitored by your account that were updated within two months of last safety rating update. |
Developers can use our web services functions page to test and become familiar with the data structures returned by our web services functions.
All web services functions must be called using a SOAP request, or a FaultCode will be returned indicating the function was not invoked as a web service.
Function Descriptions
| Functions |
Description |
| wsLogin.cfc |
Initiates your web services session. Returns SessionUUID. |
| wsGetCompany.cfc |
Returns one-dimensional array with safety rating, SafeStat scores, insurance, authority and census data for the specified MC FF MX number. |
| wsGetInsAuth.cfc |
Returns two-dimensional array with safety rating, SafeStat scores, insurance, authority and census data for all registered companies being monitored by your account that were updated within the specified number of days. |
| wsSafetyDate.cfc |
Returns one-dimensional array with the date carrier safety ratings were last updated. |
| wsGetSafetyUpdates.cfc |
Returns two-dimensional array with carrier safety ratings for registered companies being monitored by your account that were updated within two months of last safety rating update. |
| wsGetAllSafety.cfc |
Returns two-dimensional array with carrier safety ratings for all registered companies being monitored by your account. |
| wsSafeStatDate.cfc |
Returns one-dimensional array with the date SafeStat scores were last updated. |
| wsGetSafeStat.cfc |
Returns two-dimensional array with safety rating, SafeStat scores, insurance, authority and census data for all registered companies being monitored by your account with SafeStat scores greater than or equal to the specified score in one or more of the three SEA areas. |
| wsGetAllSafeStat.cfc |
Returns two-dimensional array with SafeStat scores for all registered companies being monitored by your account. |
| wsStartMonitoring.cfc |
Adds registered company to your Carrier411 account. |
| wsStopMonitoring.cfc |
Deletes registered company from your Carrier411 account. |
| wsGetInsPols.cfc |
Returns two-dimensional array with insurance policy information for the specified MC FF MX number. |
| wsGet411Status.cfc |
Returns one-dimensional array to indicate whether MC FF MX number is monitored by your Carrier411 account. |
| wsGetDocketList.cfc |
Returns two-dimensional array with docket numbers and dates for all registered companies being monitored by your Carrier411 account. |
| wsGetAllAuth.cfc |
Returns two-dimensional array with only insurance and authority data for all your registered carriers, regardless of when the information last changed. |
| wsInsAuthDateTime.cfc |
Returns one-dimensional array with the date and time FMCSA insurance and authority updates were last processed for our master database. |
wsLogin.cfc (login)
| This function emulates a member logging into the Carrier411 website. Login must be performed before any web services request can be made. The SessionUUID returned is required for all function calls and must be submitted with each subsequent web services request. Each request must also be submitted by the same IP address as the original login request.
The SessionUUID provides security and allows member-specific information to be used in functions calls. Once a web services session is established, that session is valid throughout the day until 12:00 AM (midnight) EST when it will timeout. |
| WSDL |
http://webservices.carrier411.com/wsLogin.cfc?wsdl |
| Method |
login |
| Signature |
string wsLogin.cfc( string param1, string param2 ) |
| Purpose |
Initiates your web services session. |
| Errors |
FaultCode 100: Login Failed. Not invoked as a web service.
FaultCode 101: Login failed. Invalid username or password.
FaultCode 102: Login failed. Account inactive.
FaultCode 103: Login failed. Account suspended.
FaultCode 104: Login failed. Trial accounts cannot use web services.
FaultCode 105: Login failed. Web services not activated for account.
FaultCode 106: Login failed. Requesting server IP address changed.
|
| Parameters |
string param1 -- Carrier411 username
string param2 -- Carrier411 password
|
| Returned |
struct SessionUUID -- 35-character alpha-numeric SessionUUID if login authenticated. Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsLogin Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsLogin.cfc?wsdl"
method="login"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="yourusername" />
<cfinvokeargument name="param2" value="yourpassword" />
</cfinvoke>
Example: How to Instantiate wsLogin Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsLogin.cfc?wsdl',true);
$param1="yourusername"; //Carrier411 username
$param2="yourpassword"; //Carrier411 password
$params=array($param1,$param2);
$results=$client->call("login",$params);
wsGetCompany.cfc (checkcompany)
| This function enables you to retrieve information about a company by specifying their docket number. Provide the MC, FF or MX number and your SessionUUID. This is similar to looking up an company using the Carrier411 website and viewing the company information page. It returns a one-dimensional array with 89 elements, including insurance, authority, safety rating, SafeStat scores and census data.
The docket number must not have a space between the prefix and the 6-digit docket number, such as MC455455. The docket number string must be 8 characters, including the MC, FF or MX prefix. The prefix must be MC, FF or MX. The remainder of the docket number must be 6 numbers. |
| WSDL |
http://webservices.carrier411.com/wsGetCompany.cfc?wsdl |
| Method |
checkcompany |
| Signature |
string wsGetCompany.cfc( string param1, string param2 ) |
| Purpose |
Returns safety rating, SafeStat scores, insurance, authority and census data for the specified MC FF MX number. |
| Errors |
FaultCode 200: Not invoked as a web service.
FaultCode 201: SessionUUID not valid. Login required to establish session.
FaultCode 202: SessionUUID not provided. Login required to establish session.
FaultCode 203: Docketnumber string length must be eight characters including the MC FF MX prefix.
FaultCode 204: Invalid docketnumber prefix. Two character docketnumber prefix must be MC FF MX.
FaultCode 205: Docketnumber must have six numbers following the MC FF MX prefix.
FaultCode 206: Invalid docketnumber. Docketnumber could not be found.
|
| Parameters |
string param1 -- DocketNumber
string param2 -- SessionUUID
|
| Returned |
struct One-dimensional array with 89 elements.
Otherwise, a FaultCode is returned.
Refer to Figure 1 below for sample return data. |
Example: How to Instantiate wsGetCompany Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsGetCompany.cfc?wsdl"
method="checkcompany"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="MC455455" />
<cfinvokeargument name="param2" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsGetCompany Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsGetCompany.cfc?wsdl',true);
$param1="MC455455"; //docketnumber
$param2="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1,$param2);
$results=$client->call("checkcompany",$params);
wsGetInsAuth.cfc (insuranceauthority)
| This function emulates the "Recent Insurance or Authority Changes" feature in the "Carrier Alerts" section of the Carrier411 website. It enables you to get information about your registered carriers that have been updated within the specified number of days. It is the same as being alerted to your registered carriers that have been updated, such as receiving an email alert. However, instead of simply identifying the companies that changed, this function returns a two-dimensional array that includes the docket number and 89 elements for each company. The elements for each company are the same as what is returned by the wsGetCompany.cfc function.
Insurance and authority is updated throughout the week, every Monday, Wednesday and Friday morning - usually by 10:00 AM EST. Once the update process is complete, the system will know which of your registered carriers changed that day. So you will want to invoke this process, once the updates are finished on those mornings.
Provide a one-digit number between 1 and 7 along with your SessionUUID. The number provided indicates the number of days this function uses to determine your registered carriers that changed. For example, if you specify 3, the function will return a list of your registered carriers whose insurance and authority information has been updated within the last 3 days. Specify 7 and this function will return all your carriers updated in the last 7 days. |
| WSDL |
http://webservices.carrier411.com/wsGetInsAuth.cfc?wsdl |
| Method |
insuranceauthority |
| Signature |
string wsGetInsAuth.cfc( string param1, string param2 ) |
| Purpose |
Returns safety rating, SafeStat scores, insurance, authority and census data for all your registered carriers that have had insurance or authority updates within the specified number of days. |
| Errors |
FaultCode 300: Not invoked as a web service.
FaultCode 301: SessionUUID not valid. Login required to establish session.
FaultCode 302: SessionUUID not provided. Login required to establish session.
FaultCode 303: Number of days must be numeric.
FaultCode 304: Number of days must be between one and seven.
FaultCode 305: No registered companies updated.
|
| Parameters |
string param1 -- Number of days. Numeric value between 1 and 7.
string param2 -- SessionUUID
|
| Returned |
struct Two-dimensional array with docketnumber(s) and 89 elements. Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsGetInsAuth Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsGetInsAuth.cfc?wsdl"
method="insuranceauthority"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="2" />
<cfinvokeargument name="param2" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsGetInsAuth Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsGetInsAuth.cfc?wsdl',true);
$param1=2; //number of days
$param2="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1,$param2);
$results=$client->call("insuranceauthority",$params);
wsSafetyDate.cfc (safetydate)
| Carrier safety ratings are updated once a month at the beginning of the month. Carrier safey ratings are not updated again until the beginning of the next month. Therefore, it is only necessary to invoke the wsGetSafetyUpdates function to update the safety ratings for all your registered carriers once a month, after the safety ratings are updated in our database, as determined by invoking the wsSafetyDate function.
In other words, to determine whether you should invoke the wsGetSafetyUpdates function, first invoke the wsSafetyDate function to check the date all carrier safety ratings were last updated in our database.
The date value returned by wsSafetyDate should be stored in your database for reference. When making a function call to wsSafetyDate, compare the date returned to the date stored in your database. If the date returned is greater than the date last recorded in your database, then you will want to invoke the wsGetSafetyUpdates funtion to update safety ratings for your registered carriers. Subsequently, you will also want to update the date stored with the new date returned by wsSafetyDate. |
| WSDL |
http://webservices.carrier411.com/wsSafetyDate.cfc?wsdl |
| Method |
safetydate |
| Signature |
string wsSafetyDate.cfc( string param1 ) |
| Purpose |
Returns the date carrier safety ratings last updated. |
| Errors |
FaultCode 800: Not invoked as a web service.
FaultCode 801: SessionUUID not valid. Login required to establish session.
FaultCode 802: SessionUUID not provided. Login required to establish session.
|
| Parameters |
string param1 -- SessionUUID
|
| Returned |
struct One-dimensional array with date.
Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsSafetyDate Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsSafetyDate.cfc?wsdl"
method="safetydate"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsSafetyDate Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsSafetyDate.cfc?wsdl',true);
$param1="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1);
$results=$client->call("safetydate",$params);
wsGetSafetyUpdates.cfc (checksafetyupdates)
| This function returns carrier safety ratings for all registered carriers being monitored by your Carrier411 account updated within two months of last safety rating update.
If you only want to obtain safety ratings that have been updated, wsGetSafetyUpdates is the most efficient function to use for that purpose.
wsGetSafetyUpdates is also much more efficient than invoking wsGetAllSafety, which returns safety ratings for all registered carriers (regardless of whether the safety rating was updated).
This function returns a two-dimensional array that only includes the docket number and safety ratings - SAFETYRATEDATE, SAFETYRATING, SAFETYREVDATE and SAFETYREVTYPE.
Please refer to Possible Values for Safety Ratings at the bottom of this document to understand the specific safety rating data that is returned.
Carrier safety ratings are updated once a month at the beginning of the month. Invoke the wsSafetyDate function first to determine whether is is necessary to invoke this function.
|
| WSDL |
http://webservices.carrier411.com/wsGetSafetyUpdates.cfc?wsdl |
| Method |
checksafetyupdates |
| Signature |
string wsGetSafetyUpdates.cfc( string param1 ) |
| Purpose |
Returns carrier safety ratings that have been updated for all registered companies. |
| Errors |
FaultCode 1700: Not invoked as a web service.
FaultCode 1701: SessionUUID not valid. Login required to establish session.
FaultCode 1702: SessionUUID not provided. Login required to establish session.
FaultCode 1703: No registered companies match search.
|
| Parameters |
string param1 -- SessionUUID
|
| Returned |
struct Two-dimensional array with docketnumber(s) and safety ratings. Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsGetSafetyUpdates Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsGetSafetyUpdates.cfc?wsdl"
method="checksafetyupdates"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsGetSafetyUpdates Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsGetSafetyUpdates.cfc?wsdl',true);
$param1="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1);
$results=$client->call("checksafetyupdates",$params);
wsGetAllSafety.cfc (checkallsafety)
| This function returns carrier safety ratings for all registered carriers being monitored by your Carrier411 account.
If you want to obtain safety ratings for all registered companies being monitored by your account, regardless of the date their safety ratings were last updated, then wsGetAllSafety is the function to use for that purpose.
This function returns a two-dimensional array that only includes the docket number and safety ratings - SAFETYRATEDATE, SAFETYRATING, SAFETYREVDATE and SAFETYREVTYPE.
Despite availability of the wsGetAllSafety function, we highly recommend using the wsGetSafetyUpdates function instead, because wsGetSafetyUpdates is more efficient and effective. wsGetSafetyUpdates returns carrier safety ratings for registered companies being monitored by your account that were updated within two months of last safety rating update.
Please refer to Possible Values for Safety Ratings at the bottom of this document to understand the specific safety rating data that is returned.
Carrier safety ratings are updated once a month at the beginning of the month. Invoke the wsSafetyDate function first to determine whether is is necessary to invoke this function.
|
| WSDL |
http://webservices.carrier411.com/wsGetAllSafety.cfc?wsdl |
| Method |
checkallsafety |
| Signature |
string wsGetAllSafety.cfc( string param1 ) |
| Purpose |
Returns carrier safety ratings for all registered companies. |
| Errors |
FaultCode 1100: Not invoked as a web service.
FaultCode 1101: SessionUUID not valid. Login required to establish session.
FaultCode 1102: SessionUUID not provided. Login required to establish session.
FaultCode 1103: No registered companies match search.
|
| Parameters |
string param1 -- SessionUUID
|
| Returned |
struct Two-dimensional array with docketnumber(s) and safety ratings. Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsGetAllSafety Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsGetAllSafety.cfc?wsdl"
method="checkallsafety"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsGetAllSafety Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsGetAllSafety.cfc?wsdl',true);
$param1="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1);
$results=$client->call("checkallsafety",$params);
wsSafeStatDate.cfc (safestatdate)
| SafeStat scores are updated once a month. SafeStat scores are not updated again until the next month. Therefore, it is only necessary to invoke the wsGetSafeStat function to update the SafeStat scores for all your registered carriers once a month, after the SafeStat scores are updated in our database, as determined by invoking the wsSafeStatDate function.
In other words, to determine whether you should invoke the wsGetSafeStat function, first invoke the wsSafeStatDate function to check the date all SafeStat scores were last updated in our database.
The date value returned by wsSafeStatDate should be stored in your database for reference. When making a function call to wsSafeStatDate, compare the date returned to the date stored in your database. If the date returned is greater than the date last recorded in your database, then you will want to invoke the wsGetSafeStat funtion to update SafeStat scores for your registered carriers. Subsequently, you will also want to update the date stored with the new date returned by wsSafeStatDate. |
| WSDL |
http://webservices.carrier411.com/wsSafeStatDate.cfc?wsdl |
| Method |
safestatdate |
| Signature |
string wsSafeStatDate.cfc( string param1 ) |
| Purpose |
Returns the date SafeStat scores last updated. |
| Errors |
FaultCode 900: Not invoked as a web service.
FaultCode 901: SessionUUID not valid. Login required to establish session.
FaultCode 902: SessionUUID not provided. Login required to establish session.
|
| Parameters |
string param1 -- SessionUUID
|
| Returned |
struct One-dimensional array with date.
Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsSafeStatDate Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsSafeStatDate.cfc?wsdl"
method="safestatdate"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsSafeStatDate Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsSafeStatDate.cfc?wsdl',true);
$param1="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1);
$results=$client->call("safestatdate",$params);
wsGetSafeStat.cfc (checksafestat)
| This function emulates the popular "Search by SafeStat SEA Scores" feature in the "My Carriers" section of the Carrier411 website. Specify a numeric SafeStat score between 70 and 85 along with your SessionUUID.
This function identifies all of your registered carriers with SafeStat SEA scores greater than or equal to the specified score in any one or more of the three safety evaluation areas - Driver Safety (DRSEA), Vehicle Safety (VHSEA) and Safety Management (SMSEA).
This function returns a two-dimensional array (just like the wsGetInsAuth.cfc function) that includes the docket number and 89 elements for each of your registered carriers that has the specified safety rating.
If you only want to obtain SafeStat scores for all your carriers without the additional data, please refer to the wsGetAllSafeStat function.
Like carrier safety ratings, SafeStat scores are updated once a month when SafeStat does its monthly run and publishes new data. Once the SafeStat scores are issued for the month, they do not change until the next SafeStat run. |
| WSDL |
http://webservices.carrier411.com/wsGetSafeStat.cfc?wsdl |
| Method |
checksafestat |
| Signature |
string wsGetSafeStat.cfc( string param1, string param2 ) |
| Purpose |
Returns safety rating, SafeStat scores, insurance, authority and census data for all your registered carriers that have SafeStat scores greater that or equel to the specified score. |
| Errors |
FaultCode 500: Not invoked as a web service.
FaultCode 501: SessionUUID not valid. Login required to establish session.
FaultCode 502: SessionUUID not provided. Login required to establish session.
FaultCode 503: SafeStat score must be numeric.
FaultCode 504: SafeStat score must be between 70 and 85.
FaultCode 505: No registered companies match search.
|
| Parameters |
string param1 -- Numeric SafeStat score. Must be between 70 and 85.
string param2 -- SessionUUID
|
| Returned |
struct Two-dimensional array with docketnumber(s) and 89 elements.
Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsGetSafeStat Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsGetSafestat.cfc?wsdl"
method="checksafestat"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="75" />
<cfinvokeargument name="param2" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsGetSafestat Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsGetSafestat.cfc?wsdl',true);
$param1=75; //safestat score number
$param2="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1,$param2);
$results=$client->call("checksafestat",$params);
wsGetAllSafeStat.cfc (checkallsafestat)
| This function returns SafeStat scores for all registered carriers being monitored by your Carrier411 account.
If you only want to obtain SafeStat scores (without getting all additional information for your registered carriers, such as the 89 elements returned by the wsGetSafeStat function), wsGetAllSafeStat is the most efficient function to use for that purpose.
This function returns a two-dimensional array that only includes the docket number and SafeStat scores - Driver Safety (DRSEA), Vehicle Safety (VHSEA) and Safety Management (SMSEA).
Please refer to Possible Values for SafeStat Scores at the bottom of this document to understand the specific SafeStat data that is returned.
SafeStat scores are updated once a month when SafeStat does its monthly run and publishes new data. Once the SafeStat scores are issued for the month, they do not change until the next SafeStat run.
Invoke the wsSafeStatDate function first to determine whether is is necessary to invoke this function.
|
| WSDL |
http://webservices.carrier411.com/wsGetAllSafeStat.cfc?wsdl |
| Method |
checkallsafestat |
| Signature |
string wsGetAllSafeStat.cfc( string param1 ) |
| Purpose |
Returns SafeStat scores for all registered companies. |
| Errors |
FaultCode 1000: Not invoked as a web service.
FaultCode 1001: SessionUUID not valid. Login required to establish session.
FaultCode 1002: SessionUUID not provided. Login required to establish session.
FaultCode 1003: No registered companies match search.
|
| Parameters |
string param1 -- SessionUUID
|
| Returned |
struct Two-dimensional array with docketnumber(s) and SafeStat scores. Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsGetAllSafeStat Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsGetAllSafeStat.cfc?wsdl"
method="checkallsafestat"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsGetAllSafeStat Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsGetAllSafeStat.cfc?wsdl',true);
$param1="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1);
$results=$client->call("checkallsafestat",$params);
wsStartMonitoring.cfc (startmonitoring)
| This function enables you to add a carrier to the list of registered carriers being monitored by your Carrier411 account. Provide the MC, FF or MX number and your SessionUUID. It emulates looking up a carrier and clicking the "Start Monitoring" button in the Carrier411 website. If the specified carrier is already registered for your account, a duplicate entry will not be made.
This function returns ResponseCode 0 if the company was previously registered. Otherwise, it returns ResponseCode 1 upon registering (adding) the carrier, indicating it is now being monitored by your Carrier411 account. |
| WSDL |
http://webservices.carrier411.com/wsStartMonitoring.cfc?wsdl |
| Method |
startmonitoring |
| Signature |
string wsStartMonitoring.cfc( string param1, string param2 ) |
| Purpose |
Adds registered company to your Carrier411 account. |
| Errors |
FaultCode 600: Not invoked as a web service.
FaultCode 601: SessionUUID not valid. Login required to establish session.
FaultCode 602: SessionUUID not provided. Login required to establish session.
FaultCode 603: Docketnumber string length must be eight characters including the MC FF MX prefix.
FaultCode 604: Invalid docketnumber prefix. Two character docketnumber prefix must be MC FF MX.
FaultCode 605: Docketnumber must have six numbers following the MC FF MX prefix.
FaultCode 606: Invalid docketnumber. Docketnumber could not be found.
|
| Parameters |
string param1 -- DocketNumber
string param2 -- SessionUUID
|
| Returned |
struct ResponseCode 0: Company already registered.
struct ResponseCode 1: Company successfully registered.
Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsStartMonitoring Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsStartMonitoring.cfc?wsdl"
method="startmonitoring"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="MC455455" />
<cfinvokeargument name="param2" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsStartMonitoring Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsStartMonitoring.cfc?wsdl',true);
$param1="MC455455"; //docketnumber
$param2="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1,$param2);
$results=$client->call("startmonitoring",$params);
wsStopMonitoring.cfc (stopmonitoring)
| This function enables you to delete a carrier from the list of registered carriers being monitored by your Carrier411 account. Provide the MC, FF or MX number and your SessionUUID. It emulates looking up a carrier and clicking the "Stop Monitoring" button in the Carrier411 website.
This function returns ResponseCode 0 if the company was not registered. Otherwise, it returns ResponseCode 1 upon deleting the carrier, indicating it is no longer being monitored by your Carrier411 account. |
| WSDL |
http://webservices.carrier411.com/wsStopMonitoring.cfc?wsdl |
| Method |
stopmonitoring |
| Signature |
string wsStopMonitoring.cfc( string param1, string param2 ) |
| Purpose |
Deletes registered company from your Carrier411 account. |
| Errors |
FaultCode 700: Not invoked as a web service.
FaultCode 701: SessionUUID not valid. Login required to establish session.
FaultCode 702: SessionUUID not provided. Login required to establish session.
FaultCode 703: Docketnumber string length must be eight characters including the MC FF MX prefix.
FaultCode 704: Invalid docketnumber prefix. Two character docketnumber prefix must be MC FF MX.
FaultCode 705: Docketnumber must have six numbers following the MC FF MX prefix.
|
| Parameters |
string param1 -- DocketNumber
string param2 -- SessionUUID
|
| Returned |
struct ResponseCode 0: Company not registered.
struct ResponseCode 1: Company deleted from monitoring list.
Otherwise, a FaultCode is returned.
|
Example: How to Instantiate wsStopMonitoring Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsStopMonitoring.cfc?wsdl"
method="stopmonitoring"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="MC455455" />
<cfinvokeargument name="param2" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsStopMonitoring Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsStopMonitoring.cfc?wsdl',true);
$param1="MC455455"; //docketnumber
$param2="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1,$param2);
$results=$client->call("stopmonitoring",$params);
wsGetInsPols.cfc (activeinsurance)
| This function enables you to retrieve known insurance policy information for a company by specifying their docket number. Provide the MC, FF or MX number and your SessionUUID. Refer to Figure 2 below for more information. |
| WSDL |
http://webservices.carrier411.com/wsGetInsPols.cfc?wsdl |
| Method |
activeinsurance |
| Signature |
string wsGetInsPols.cfc( string param1, string param2 ) |
| Purpose |
Returns information about each known insurance policy for the specified MC FF MX number. |
| Errors |
FaultCode 1200: Not invoked as a web service.
FaultCode 1201: SessionUUID not valid. Login required to establish session.
FaultCode 1202: SessionUUID not provided. Login required to establish session.
FaultCode 1203: Docketnumber string length must be eight characters including the MC FF MX prefix.
FaultCode 1204: Invalid docketnumber prefix. Two character docketnumber prefix must be MC FF MX.
FaultCode 1205: Docketnumber must have six numbers following the MC FF MX prefix.
FaultCode 1206: Invalid docketnumber. Docketnumber could not be found.
FaultCode 1207: No insurance policy information available.
|
| Parameters |
string param1 -- DocketNumber
string param2 -- SessionUUID
|
| Returned |
struct Two-dimensional array with information about each known insurance policy. Otherwise, a FaultCode is returned. Refer to Figure 2 below for structure elements and possible values specifically returned by the wsGetInsPols function. |
Example: How to Instantiate wsGetInsPols Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsGetInsPols.cfc?wsdl"
method="activeinsurance"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="MC455455" />
<cfinvokeargument name="param2" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsGetInsPols Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsGetInsPols.cfc?wsdl',true);
$param1="MC455455"; //docketnumber
$param2="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1,$param2);
$results=$client->call("activeinsurance",$params);
wsGet411Status.cfc (checkmonitoring)
| This function determines whether the company is monitored by your Carrier411 account. Provide the MC, FF or MX number and your SessionUUID.
This function returns ResponseCode 0 if the company is not registered in your Carrier411 account. i.e. ResponseCode 0 indicates the company is not being monitored. Otherwise, it returns ResponseCode 1 to indicate the company is registered and monitored by your Carrier411 account.
One practical use for this function is to determine whether you need to display a "Start Monitoring" button or a "Stop Monitoring" button in your software application when users view information about the company. |
| WSDL |
http://webservices.carrier411.com/wsGet411Status.cfc?wsdl |
| Method |
checkmonitoring |
| Signature |
string wsGet411Status.cfc( string param1, string param2 ) |
| Purpose |
Determines whether company is monitord by your Carrier411 account as a registered carrier. |
| Errors |
FaultCode 1300: Not invoked as a web service.
FaultCode 1301: SessionUUID not valid. Login required to establish session.
FaultCode 1302: SessionUUID not provided. Login required to establish session.
FaultCode 1303: Docketnumber string length must be eight characters including the MC FF MX prefix.
FaultCode 1304: Invalid docketnumber prefix. Two character docketnumber prefix must be MC FF MX.
FaultCode 1305: Docketnumber must have six numbers following the MC FF MX prefix.
|
| Parameters |
string param1 -- DocketNumber
string param2 -- SessionUUID
|
| Returned |
struct ResponseCode 0: Company not monitored.
struct ResponseCode 1: Company monitored.
Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsGet411Status Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsGet411Status.cfc?wsdl"
method="checkmonitoring"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="MC455455" />
<cfinvokeargument name="param2" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsGet411Status Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsGet411Status.cfc?wsdl',true);
$param1="MC455455"; //docketnumber
$param2="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1,$param2);
$results=$client->call("checkmonitoring",$params);
wsGetDocketList.cfc (getlist)
| This function enables you to retrieve a list of docket numbers for all registered carriers being monitored by your Carrier411 account. It returns a two-dimensional array with the docket number, date registered and the date insurance and authority information was last updated for the company. |
| WSDL |
http://webservices.carrier411.com/wsGetDocketList.cfc?wsdl |
| Method |
getlist |
| Signature |
string wsGetDocketList.cfc( string param1 ) |
| Purpose |
Returns docket numbers and dates for all registered companies being monitored by your account. |
| Errors |
FaultCode 1400: Not invoked as a web service.
FaultCode 1401: SessionUUID not valid. Login required to establish session.
FaultCode 1402: SessionUUID not provided. Login required to establish session.
FaultCode 1403: No registered companies.
|
| Parameters |
string param1 -- SessionUUID
|
| Returned |
struct Two-dimensional array with docket numbers and dates for all registered companies being monitored by your account.
Otherwise, a FaultCode is returned.
|
Example: How to Instantiate wsGetDocketList Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsGetDocketList.cfc?wsdl"
method="getlist"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsGetDocketList Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsGetDocketList.cfc?wsdl',true);
$param1="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1);
$results=$client->call("getlist",$params);
wsGetAllAuth.cfc (getallauthority)
| This function only returns data about inusurance and authority for all registered carriers being monitored by your Carrier411 account in a two-dimensional array with the docket number(s).
The wsGetAllAuth function is different than wsGetInsAuth, which returns information about registered carriers that were updated within a specified number of days.
Instead, wsGetAllAuth returns information for all registered carriers being monitored, regardless of when they were last updated. The wsGetAllAuth function returns limited information for insurance and authority only and does not provide other information, such as safety ratings, SafeStat scores or census data. |
| WSDL |
http://webservices.carrier411.com/wsGetAllAuth.cfc?wsdl |
| Method |
getallauthority |
| Signature |
string wsGetAllAuth.cfc( string param1 ) |
| Purpose |
Returns only insurance and authority data for all your registered carriers, regardless of when the information last changed. |
| Errors |
FaultCode 1500: Not invoked as a web service.
FaultCode 1501: SessionUUID not valid. Login required to establish session.
FaultCode 1502: SessionUUID not provided. Login required to establish session.
FaultCode 1503: No registered companies.
|
| Parameters |
string param1 -- SessionUUID
|
| Returned |
struct Two-dimensional array with docketnumber(s) along with information about insurance and authority. |
Example: How to Instantiate wsGetAllAuth Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsGetAllAuth.cfc?wsdl"
method="getallauthority"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsGetAllAuth Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsGetAllAuth.cfc?wsdl',true);
$param1="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1);
$results=$client->call("getallauthority",$params);
wsInsAuthDateTime.cfc (insauthdatetime)
| FMCSA data for insurance and authority updates is processed by our system every Monday, Wednesday and Friday morning.
To determine whether you should invoke the wsGetInsAuth function that day (which is used to update your system for insurance and authority changes in the registered companies being monitored by your Carrier411 account), first invoke the wsInsAuthDateTime function to check the date and time insurance and authority changes were last updated in our master database.
The values returned by wsInsAuthDateTime should be stored and kept updated in your database. The time value is based on Eastern Standard Time (EST).
wsInsAuthDateTime is a function you will want to invoke once a day throughout the business week (Monday through Friday) in the morning, usually about 10:00 AM EST. The reason for invoking wsInsAuthDateTime about 10:00 AM EST is to ensure you do not invoke it (and subsequently the wsGetInsAuth function) before our insurance and authority updates complete processing that morning.
Again, the date and time values returned by wsInsAuthDateTime should be stored in your database for reference.
When making a function call to wsInsAuthDateTime, compare the date and time it returns to the stored date and time in your system (for the last insurance and authority update to our master database). If the date returned is today's date, then you will want to invoke the wsGetInsAuth funtion to update insurance and authority information for your registered carriers.
Be sure to compare the date stored in your database with the date returned by wsInsAuthDateTime to determine the numeric parameter required for the wsGetInsAuth function (a one-digit number between 1 and 7 that indicates the number of days wsGetInsAuth uses to determine your carriers that changed).
|
| WSDL |
http://webservices.carrier411.com/wsInsAuthDateTime.cfc?wsdl |
| Method |
insauthdatetime |
| Signature |
string wsInsAuthDateTime.cfc( string param1 ) |
| Purpose |
Returns the date and time our master database was last updated for insurance and authority changes. |
| Errors |
FaultCode 1600: Not invoked as a web service.
FaultCode 1601: SessionUUID not valid. Login required to establish session.
FaultCode 1602: SessionUUID not provided. Login required to establish session.
|
| Parameters |
string param1 -- SessionUUID
|
| Returned |
struct One-dimensional array with date and time insurance and authority updates were last processed for our master database.
Otherwise, a FaultCode is returned. |
Example: How to Instantiate wsInsAuthDateTime Function Using ColdFusion
<cfinvoke webservice="http://webservices.carrier411.com/wsInsAuthDateTime.cfc?wsdl"
method="insauthdatetime"
returnvariable="carrier411data">
<cfinvokeargument name="param1" value="FB1F7AE1-3048-71E3-611C9EE38EC1572F" />
</cfinvoke>
Example: How to Instantiate wsInsAuthDateTime Function with PHP Using NuSoap Libraries
include("nusoap.php");
$client= new
soapclient('http://webservices.carrier411.com/wsInsAuthDateTime.cfc?wsdl',true);
$param1="FB1F7AE1-3048-71E3-611C9EE38EC1572F"; //sessionuuid
$params=array($param1);
$results=$client->call("insauthdatetime",$params);
Figure 1: Return Data for Docket Number
| struct |
| CENSUSBEVERAGES |
[empty string] |
| CENSUSBLDGMAT |
X |
| CENSUSCARGOOTHR |
[empty string] |
| CENSUSCHEM |
X |
| CENSUSCLASS |
A |
| CENSUSCLASSDEF |
[empty string] |
| CENSUSCOALCOKE |
[empty string] |
| CENSUSCOLDFOOD |
X |
| CENSUSCONSTRUCT |
[empty string] |
| CENSUSDBNUM |
[empty string] |
| CENSUSDRIVETOW |
[empty string] |
| CENSUSDRYBULK |
X |
| CENSUSEMAILADDRESS |
RASTEPTAXPLACE@ALLTEL.NET |
| CENSUSFARMSUPP |
[empty string] |
| CENSUSGARBAGE |
[empty string] |
| CENSUSGENFREIGHT |
X |
| CENSUSGRAINFEED |
X |
| CENSUSHOUSEHOLD |
[empty string] |
| CENSUSINTERMODAL |
[empty string] |
| CENSUSLIQGAS |
[empty string] |
| CENSUSLIVESTOCK |
[empty string] |
| CENSUSLOGPOLE |
X |
| CENSUSMACHLRG |
[empty string] |
| CENSUSMCS150DATE |
08/08/2006 |
| CENSUSMCS150MILEAGEYEAR |
2004 |
| CENSUSMEAT |
X |
| CENSUSMETALSHEET |
[empty string] |
| CENSUSMLG150 |
240000 |
| CENSUSMOBILEHOME |
[empty string] |
| CENSUSMOTORVEH |
[empty string] |
| CENSUSOILFIELD |
[empty string] |
| CENSUSOTHERCARGO |
[empty string] |
| CENSUSOWNTRACT |
4 |
| CENSUSOWNTRAIL |
4 |
| CENSUSPAPERPROD |
X |
| CENSUSPASSENGERS |
[empty string] |
| CENSUSPRODUCE |
X |
| CENSUSTOTDRS |
3 |
| CENSUSTOTPWR |
4 |
| CENSUSTRMTRACT |
0 |
| CENSUSTRMTRAIL |
0 |
| CENSUSUSMAIL |
X |
| CENSUSUTILITY |
[empty string] |
| CENSUSWATERWELL |
[empty string] |
| FMCSAAPPLICANTID |
368224 |
| FMCSABIPDFILED |
0 |
| FMCSABIPDREQUIRED |
750000 |
| FMCSABONDFILED |
N |
| FMCSABONDREQUIRED |
N |
| FMCSABROKER |
N |
| FMCSABUSADDRESS |
109 S. DOOLY ST. |
| FMCSABUSCITY |
MONTEZUMA |
| FMCSABUSCOUNTRY |
US |
| FMCSABUSFAX |
[empty string] |
| FMCSABUSPHONE |
4784725773 |
| FMCSABUSSTATE |
GA |
| FMCSABUSZIP |
31063 |
| FMCSACARGOFILED |
N |
| FMCSACARGOREQUIRED |
Y |
| FMCSACOMMON |
I |
| FMCSACONTRACT |
N |
| FMCSADATELASTUPDATED |
11/03/2006 |
| FMCSADBANAME |
STEPHENS' TRUCK LINE |
| FMCSADOCKETNUMBER |
MC455455 |
| FMCSADOTNUMBER |
1228268 |
| FMCSAFREIGHT |
Y |
| FMCSAHOUSEHOLD |
N |
| FMCSALEGALNAME |
R A STEPHENS |
| FMCSAMAILADDRESS |
P O BOX 457 |
| FMCSAMAILCITY |
MONTEZUMA |
| FMCSAMAILCOUNTRY |
US |
| FMCSAMAILFAX |
[empty string] |
| FMCSAMAILPHONE |
[empty string] |
| FMCSAMAILSTATE |
GA |
| FMCSAMAILZIP |
31063 |
| FMCSAPASSENGER |
N |
| FMCSAPENDINGBROKER |
N |
| FMCSAPENDINGCOMMON |
N |
| FMCSAPENDINGCONTRACT |
N |
| FMCSAREVOKINGBROKER |
N |
| FMCSAREVOKINGCOMMON |
N |
| FMCSAREVOKINGCONTRACT |
N |
| SAFESTATDRSEA |
91.78 |
| SAFESTATSMSEA |
[empty string] |
| SAFESTATVHSEA |
96.32 |
| SAFETYRATEDATE |
07/26/2006 |
| SAFETYRATING |
C |
| SAFETYREVDATE |
05/11/2006 |
| SAFETYREVTYPE |
C |
Structure Elements and Possible Values
| 1. |
CENSUSBEVERAGES |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Beverages". |
| 2. |
CENSUSBLDGMAT |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Building Materials". |
| 3. |
CENSUSCARGOOTHR |
CHAR 1 |
| Possible Values: X or NULL. When value is X then display the type of cargo specified in the value for CENSUSOTHERCARGO. |
| 4. |
CENSUSCHEM |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Chemicals". |
| 5. |
CENSUSCLASS |
VARCHAR 12 |
| Possible Values: ABCDEFGHIJKL. Values indicate the carrier's "Operation Classification". Carriers can have more than one type of classification. Therefore, this field may contain an alpha string with multiple values. i.e. AGHL
Values listed are consecutive. You must read through the alpha string to identify individual classifications:
- A = Authorized-for-Hire
- B = Exempt-for-Hire
- C = Private (Property)
- D = Private/Passenger Business
- E = Private/Passenger Non-Business
- F = Migrant
- G = U.S. Mail
- H = Federal Government
- I = State Government
- J = Local Government
- K = Indian Tribe
- L = Display text in CENSUSCLASSDEF
When the CENSUSCLASS value string contains L then display the textual value indicated in CENSUSCLASSDEF.
|
| 6. |
CENSUSCLASSDEF |
VARCHAR 50 |
| Possible Values: NULL or Text. Display the text in CENSUSCLASSDEF when the CENSUSCLASS alpha string contains L as explained above. This value represents an Operation Classification designated by the carrier. |
| 7. |
CENSUSCOALCOKE |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Coal/Coke". |
| 8. |
CENSUSCOLDFOOD |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Refrigerated Food". |
| 9. |
CENSUSCONSTRUCT |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Construction". |
| 10. |
CENSUSDBNUM |
VARCHAR 9 |
| Possible Values: NULL or number. This is the carrier's Dun & Bradstreet number. |
| 11. |
CENSUSDRIVETOW |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Drive/Tow Away". |
| 12. |
CENSUSDRYBULK |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Commodities Dry Bulk". |
| 13. |
CENSUSEMAILADDRESS |
VARCHAR 80 |
| Possible Values: NULL or text. This is the carrier's email address. It can be linked with a mailto tag if desired. |
| 14. |
CENSUSFARMSUPP |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Agricultural/Farm Supplies". |
| 15. |
CENSUSGARBAGE |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Garbage/Refuse". |
| 16. |
CENSUSGENFREIGHT |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "General Freight". |
| 17. |
CENSUSGRAINFEED |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Grain, Feed, Hay". |
| 18. |
CENSUSHOUSEHOLD |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Household Goods". |
| 19. |
CENSUSINTERMODAL |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Intermodal Containers". |
| 20. |
CENSUSLIQGAS |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Liquids/Gases". |
| 21. |
CENSUSLIVESTOCK |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Livestock". |
| 22. |
CENSUSLOGPOLE |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Logs, Poles, Beams, Lumber". |
| 23. |
CENSUSMACHLRG |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Machinery, Large Objects". |
| 24. |
CENSUSMCS150DATE |
DATETIME |
| Possible Values: NULL or Date formatted as mm/dd/yyyy. This is the date the carrier filed its most recent MCS-150 form with the FMCSA. |
| 25. |
CENSUSMCS150MILEAGEYEAR |
INTEGER 4 |
| Possible Values: NULL or 4-digit year. This is the year for reported "Mileage" on the MCS-150 form. Even though there is census data and a year value exists for CENSUSMCS150DATE, this field may be NULL. This value is associated with the "Mileage" indicated in CENSUSMLG150. |
| 26. |
CENSUSMEAT |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Meat". |
| 27. |
CENSUSMETALSHEET |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Metal (Sheets, Coils, Rolls)". |
| 28. |
CENSUSMLG150 |
INTEGER 4 |
| Possible Values: NULL or number. This is reported "Mileage" on the MCS-150 form. Even though there is census data and a year value exists for CENSUSMCS150DATE, this field may be NULL. This value is associated with the CENSUSMCS150MILEAGEYEAR value. |
| 29. |
CENSUSMOBILEHOME |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Mobile Homes". |
| 30. |
CENSUSMOTORVEH |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Motor Vehicles". |
| 31. |
CENSUSOILFIELD |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Oilfield Equipment". |
| 32. |
CENSUSOTHERCARGO |
VARCHAR 50 |
| Possible Values: NULL or whatever text was specified by the carriers when completing FMCSA documents. Display whatever textual information is provided when CENSUSCARGOOTHR value is X. |
| 33. |
CENSUSOWNTRACT |
VARCHAR 5 |
| Possible Values: NULL or numeric value. This value indicates the total number of "Owned Tractors" operated by the carrier. |
| 34. |
CENSUSOWNTRAIL |
VARCHAR 5 |
| Possible Values: NULL or numeric value. This value indicates the total number of "Owned Trailers" operated by the carrier. |
| 35. |
CENSUSPAPERPROD |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Paper Products". |
| 36. |
CENSUSPASSENGERS |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Passengers". |
| 37. |
CENSUSPRODUCE |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Fresh Produce". |
| 38. |
CENSUSTOTDRS |
VARCHAR 6 |
| Possible Values: NULL or numeric value. This value indicates the total number of "Drivers" working for the carrier. |
| 39. |
CENSUSTOTPWR |
VARCHAR 6 |
| Possible Values: NULL or numeric value. This value indicates the total number of "Power Units" operated by the carrier. |
| 40. |
CENSUSTRMTRACT |
VARCHAR 5 |
| Possible Values: NULL or numeric value. This value indicates the total number of "Leased Tractors" operated by the carrier. |
| 41. |
CENSUSTRMTRAIL |
VARCHAR 5 |
| Possible Values: NULL or numeric value. This value indicates the total number of "Leased Trailers" operated by the carrier. |
| 42. |
CENSUSUSMAIL |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "U.S. Mail". |
| 43. |
CENSUSUTILITY |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Utilities". |
| 44. |
CENSUSWATERWELL |
CHAR 1 |
| Possible Values: X or NULL. Indicates whether carrier designated this as a type of cargo carried. When value is X then indicate "Water Well". |
| 45. |
FMCSAAPPLICANTID |
VARCHAR 10 |
| The FMCSAAPPLICANTID value must be used for linking to the FMCSA website in order to display the Authority History, Revocation History, Active/Pending Insurance and Insurance History for an MC number. The FMCSAAPPLICANTID value for an MC number is unique to the specific MC number. As used above in the example links for MC455455, the FMCSAAPPLICANTID value is required for the pv_apcant_id name value pair. The pv_apcant_id value for MC455455 is 368224. |
| 46. |
FMCSABIPDFILED |
VARCHAR 10 |
| This value indicates the dollar amount of liability insurance on file for the company, as reported to the FMCSA by insurance underwriters. Even though BIPD insurance may not be required, some companies will maintain a BIPD insurance policy. |
| 47. |
FMCSABIPDREQUIRED |
VARCHAR 10 |
| BIPD is bodily injury property damage, more commonly known as liability insurance. If BIPD is required by the FMCSA, the minimum dollar amount of required coverage will be specified. If required, the minimum amount is usually 750000 ($750,000.00), but it could be higher. It could also be 0 (zero), if BIPD is not required. FMCSA requires companies with contract authority to have BIPD insurance. |
| 48. |
FMCSABONDFILED |
CHAR 1 |
| Possible Values: Y or N. This value indicates whether a broker bond is on file for the company, as reported to the FMCSA by insurance underwriters. There are two possible values: "Y" for yes or "N" for no. |
| 49. |
FMCSABONDREQUIRED |
CHAR 1 |
| Possible Values: Y or N. This value indicates whether the FMCSA requires the company to have a bond. There are two possible values: "Y" for yes or "N" for no. FMCSA requires companies with broker authority to maintain a bond. |
| 50. |
FMCSABROKER |
CHAR 1 |
| This value describes the company's broker authority status. There are three possible values: "A" for active broker authority, "I" for inactive broker authority or "N" for no broker authority. |
| 51. |
FMCSABUSADDRESS |
VARCHAR 50 |
| This is the business address for the company. |
| 52. |
FMCSABUSCITY |
VARCHAR 30 |
| This value is the city for the business address specified in FMCSABUSADDRESS. |
| 53. |
FMCSABUSCOUNTRY |
CHAR 2 |
| This is the 2-character country for the business address specified in FMCSABUSADDRESS. You do not necessary have to display this value. |
| 54. |
FMCSABUSFAX |
VARCHAR 14 |
| This value is the 10-digit business fax number if provided. The value may be NULL. It should be displayed by the business address. Some times there are less than 10 digits. When there are less than 10 digits, you should probably not format the number and identify the problem to the carrier. |
| 55. |
FMCSABUSPHONE |
VARCHAR 14 |
| This value is the 10-digit business phone number if provided. The value may be NULL. It should be displayed by the business address. Some times there are less than 10 digits. When there are less than 10 digits, you should probably not format the number and identify the problem to the carrier. |
| 56. |
FMCSABUSSTATE |
CHAR 2 |
| This value is the 2-character state for the business address specified in FMCSABUSADDRESS. |
| 57. |
FMCSABUSZIP |
VARCHAR 10 |
| This value is the zip code for the business address specified in FMCSABUSADDRESS. Most zip codes are 5 digits. Some are zip plus 4. Others are international postal codes. |
| 58. |
FMCSACARGOFILED |
CHAR 1 |
| This value indicates whether cargo insurance is on file for the company, as reported to the FMCSA by insurance underwriters. There are two possible values: "Y" for yes or "N" for no. Even though cargo insurance may not be required, some companies will maintain a cargo insurance policy. |
| 59. |
FMCSACARGOREQUIRED |
CHAR 1 |
| This value indicates whether the FMCSA requires the company to have cargo insurance. There are two possible values: "Y" for yes or "N" for no. FMCSA requires companies with common authority to have cargo insurance. |
| 60. |
FMCSACOMMON |
CHAR 1 |
| This value describes the company's common carrier authority status. There are three possible values: "A" for active common authority, "I" for inactive common authority or "N" for no common authority. |
| 61. |
FMCSACONTRACT |
CHAR 1 |
| This value describes the company's contract carrier authority status. There are three possible values: "A" for active contract authority, "I" for inactive contract authority or "N" for no contract authority. |
| 62. |
FMCSADATELASTUPDATED |
DATETIME |
| This the mm/dd/yyyy date that insurance and authority information about the company was last updated in our database. |
| 63. |
FMCSADBANAME |
VARCHAR 60 |
| This is the doing-business-as (dba) name for the company. It should be displayed below the legal name. |
| 64. |
FMCSADOCKETNUMBER |
CHAR 8 |
| This is the motor carrier (MC) number for the company. It may also be an FF or MX number for freight forwarders or Mexican carriers. |
| 65. |
FMCSADOTNUMBER |
NUMERIC 9 |
| This is the USDOT number for the carrier. Values may include 0 or NULL, neither of which should be displayed. |
| 66. |
FMCSAFREIGHT |
CHAR 1 |
| Possible Values: Y or NThis is the "Cargo Authorization" for "Property" Y for Yes and N for No. |
| 67. |
FMCSAHOUSEHOLD |
CHAR 1 |
| Possible Values: Y or NThis is the "Cargo Authorization" for "Household Goods" Y for Yes and N for No. |
| 68. |
FMCSALEGALNAME |
VARCHAR 120 |
| This is the legal name of the company and should be displayed with the business address information. |
| 69. |
FMCSAMAILADDRESS |
VARCHAR 50 |
| This is the optional mailing address for the carrier, in addition to their business address specified in FMCSABUSADDRESS. Some times companies specify a separate mailing address, rather than have mail go to their business address. |
| 70. |
FMCSAMAILCITY |
VARCHAR 30 |
| This value is the city for the mailing address specified in FMCSAMAILADDRESS. |
| 71. |
FMCSAMAILCOUNTRY |
CHAR 2 |
| This is the 2-character country for the mailing address specified in FMCSAMAILADDRESS. You do not necessary have to display this value. |
| 72. |
FMCSAMAILFAX |
VARCHAR 14 |
| This value is the 10-digit mailing address fax number if provided. The value may be NULL. It should be displayed by the mailing address. Some times there are less than 10 digits. When there are less than 10 digits, you should probably not format the number and identify the problem to the carrier. |
| 73. |
FMCSAMAILPHONE |
VARCHAR 14 |
| This value is the 10-digit mailing address phone number if provided. The value may be NULL. It should be displayed by the mailing address. Some times there are less than 10 digits. When there are less than 10 digits, you should probably not format the number and identify the problem to the carrier. |
| 74. |
FMCSAMAILSTATE |
CHAR 2 |
| This value is the 2-character state for the mailing address specified in FMCSAMAILADDRESS. |
| 75. |
FMCSAMAILZIP |
VARCHAR 10 |
| This value is the zip code for the mailing address specified in FMCSAMAILADDRESS. Most zip codes are 5 digits. Some are zip plus 4. Others are international postal codes. |
| 76. |
FMCSAPASSENGER |
CHAR 1 |
| Possible Values: Y or N. This is the "Cargo Authorization" for "Passenger" Y for Yes and N for No. |
| 77. |
FMCSAPENDINGBROKER |
CHAR 1 |
| Possible Values: Y or N. This value describes whether the company has applied for broker authority and is in the process of receiving it. There are two possible values: "Y" for yes or "N" for no. |
| 78. |
FMCSAPENDINGCOMMON |
CHAR 1 |
| Possible Values: Y or N. This value describes whether the company has applied for common carrier authority and is in the process of receiving it. There are two possible values: "Y" for yes or "N" for no. |
| 79. |
FMCSAPENDINGCONTRACT |
CHAR 1 |
| Possible Values: Y or N. This value describes whether the company has applied for contract carrier authority and is in the process of receiving it. There are two possible values: "Y" for yes or "N" for no. |
| 80. |
FMCSAREVOKINGBROKER |
CHAR 1 |
| Possible Values: Y or N. This value describes whether the company is pending revocation of its broker authority. It may soon lose authority. There are two possible values: "Y" for yes or "N" for no. Yes usually indicates the company is within 30 days of the premium being due for its broker bond, and it remains unpaid. However, there are other reasons this warning flag may get raised. |
| 81. |
FMCSAREVOKINGCOMMON |
CHAR 1 |
| Possible Values: Y or N. This value describes whether the company is pending revocation of its common carrier authority. It may soon lose authority. There are two possible values: "Y" for yes or "N" for no. Yes does not mean they have lost their common carrier authority. Yes usually indicates the company is within 30 days of its insurance premium being due, and it remains unpaid. However, there are other reasons this warning flag may get raised. |
| 82. |
FMCSAREVOKINGCONTRACT |
CHAR 1 |
| Possible Values: Y or N. This value describes whether the company is pending revocation of its contract carrier authority. It may soon lose authority. There are two possible values: "Y" for yes or "N" for no. Yes usually indicates the company is within 30 days of its insurance premium being due, and it remains unpaid. However, there are other reasons this warning flag may get raised. |
| 83. |
SAFESTATDRSEA |
REAL 4 |
| Possible Values: NULL or number. This value is the numeric Driver Safety Evaluation Area (DRSEA) SafeStat score. This value may be NULL. Numeric values range from 0 to 100, and any score 75 or above is considered deficient and should be highlighted. Scores may have two decimal places, such as 63.85. |
| 84. |
SAFESTATSMSEA |
REAL 4 |
| Possible Values: NULL or number. This value is the numeric Safety Management Evaluation Area (SMSEA) SafeStat score. This value may be NULL. Numeric values range from 0 to 100, and any score 75 or above is considered deficient and should be highlighted. Scores may have two decimal places, such as 63.85. |
| 85. |
SAFESTATVHSEA |
REAL 4 |
| Possible Values: NULL or number. This value is the numeric Vehicle Safety Evaluation Area (VHSEA) SafeStat score. This value may be NULL. Numeric values range from 0 to 100, and any score 75 or above is considered deficient and should be highlighted. Scores may have two decimal places, such as 63.85. |
| 86. |
SAFETYRATEDATE |
DATETIME |
| Possible Values: NULL or date. If the carrier has a carrier safety rating value specifies in SAFETYRATING, this is the date the safety rating was issued formatted as mm/dd/yyyy. If the carrier has no safety rating, the value will be NULL. |
| 87. |
SAFETYRATING |
CHAR 1 |
| Possible Values: NULL or single letter. This is the carrier safety rating. There are three possible safety ratings: U = Unsatisfactory, C = Conditional, S = Satisfactory. The safety rating was issues on the date specified in SAFETYRATEDATE. |
| 88. |
SAFETYREVDATE |
DATETIME |
| Possible Values: NULL or date. If the carrier has a safety rating, this is the safety rating "review date" formatted as mm/dd/yyyy. The review date is always earlier than the safety rating date in SAFETYRATEDATE.It is based on the safety review that the carrier is assigned a safety rating. If the carrier has no safety rating, the SAFETYREVDATE value would be NULL because there was no safety review. |
| 89. |
SAFETYREVTYPE |
CHAR 1 |
< |
