Version 1

Registry Monitoring Insurance Services, Inc. (RMIS)

RMIS Transportation
Carrier Attach / Detach API Documentation
Updated 7/28/2014

Registry Monitoring Insurance Services, Inc.

5703 Corsa Ave.
Westlake Village, CA 91362
800-400-4924
RMIS Transportation
Carrier Attach / Detach API
Documentation
Table of Contents
Attach / Detach Integration Summary .......................................................................................................... 1
Purpose ..................................................................................................................................................... 1
CRS+ Clients and Monitoring Only Clients ................................................................................................ 2
How to get Support ................................................................................................................................... 2
Attach API Quick Start ............................................................................................................................... 2
Building the Attach API URL .......................................................................................................................... 4
The Base URL............................................................................................................................................. 4
Required Arguments ................................................................................................................................. 4
Optional Argument (ClientInsuredID) ....................................................................................................... 5
Putting the Attach API Together ................................................................................................................... 5
Handling Attach API Return Values............................................................................................................... 6
Building the Detach API URL ......................................................................................................................... 7
Handling Detach API Return Values .............................................................................................................. 8
Building the Update API URL......................................................................................................................... 9

Attach / Detach Integration Summary

Purpose
Registry Monitoring Insurance Services, Inc. (RMIS) provides carrier compliance services. Carriers can be
added to be monitored for a customer (attached) several ways so that RMIS will begin to monitor the
insurance/DOT status of a single carrier on behalf of a customer. The Attach API can be used to
automatically add a carrier to the RMIS monitoring list for a customer. Conversely, if a client wishes to
remove a carrier from being monitored by RMIS, the Detach API can be used.

Note: the RMIS system allows clients to monitor a single carrier with multiple mapping IDs
(ClientsCarrierID). That means that a single carrier can be added twice (or more times) to RMIS, but can

1 RMIS Transportation – Attach/Detach API – 7/28/14

be mapped with multiple unique IDs to assist the client in mapping their own internal IDs for a carrier.
The Attach/Detach API is sensitive to this mapping. Please carefully note in the documentation below
the process for attaching/detaching carrier with/without custom mapped IDs.
Most customers use the RMIS hosted custom website to allow vendors to register for compliance
monitoring, to allow client personnel monitor vendor status, and allow vendors to make changes and
updates to their monitoring profile.

CRS+ Clients and Monitoring Only Clients

RMIS supports two basic types of clients, those using our CRS+ Carrier Onboarding Service, and our
Monitoring Only service. CRS+ is a system that allows clients to perform a complete online onboarding
for their carriers completely online using the RMIS system. RMIS captures all of the onboarding
information including (but not limited to) lane information, profile data, insurance agent information,
diversity information, agreement signatures, hazmat and certification detail, W9 information and more.
In addition to the onboarding data, RMIS then monitors the carrier’s insurance information and their
DOT data.

An RMIS Monitoring Only client has RMIS monitor only insurance and DOT information, but not the
onboarding data which is unique to the CRS+ information. The same RMIS Transportation API supports
both monitoring and CRS+ accounts.

The Attach/Detach API works for BOTH types of RMIS clients. NOTE: if a carrier is attached via API to a
CRS+ client’s account, RMIS will begin monitoring the carrier for the client, BUT the carrier will NOT
automatically be registered through the onboarding process. The Attach API will ONLY add the carrier
for basic monitoring services.

Using the Detach API will make the carrier invisible to the client in the RMIS system. If the client needs
to preserve historical information about a carrier (agreements, certificates, W9s, certification status,
etc.) the client would be advised NOT to use the Detach API since that information will be removed from
their system.

How to get Support

You can get support by contacting your RMIS sales person or customer service at 800-400-4924. You
may request IT support by email at [email protected].

Attach API Quick Start

1. Ask your RMIS representative for your domain name, client ID and password.
2. Paste the following line into your web browser:
https://<domainname>.rmissecure.com/_c/std/api/AttachCarrier.aspx?clientID=<ClientID>&pw
d=<Pwd>&MCNumber=<MCNumber>&clientsCarrierID=<ClientsInsuredID>&attachMode=Attac
h
3. REPLACE “<domainname>” with the custom client domain name that RMIS secured for you.
4. REPLACE “<ClientID>” with your client ID. (Be sure the <>s are removed.)

2 RMIS Transportation – Attach/Detach API – 7/28/14

5. REPLACE “<Pwd>” with your password. (Be sure the <>s are removed.)
6. REPLACE “<MCNumber>” with the carrier’s MC# you wish to attach. (Be sure the <>s are
removed.)
7. REPLACE “<ClientsInsuredID>” with the client’s unique ID for the carrier in their system. (Be sure
the <>s are removed.) NOTE: the ClientInsuredID can be blank.
8. Hit Enter!

3 RMIS Transportation – Attach/Detach API – 7/28/14

Building the Attach API URL
The Attach API is built using a simple HTTP GET or POST. First, you must build the base URL for the API
call, then supply the required arguments for the Attach API. Second, add any of the optional arguments
required.

The Base URL

The Base URL can be called using a customer’s custom RMIS domain using HTTPS (SSL encryption) for
added security, or can be built using the ‘generic’ RMIS API URL using standard http (without SSL
encryption).

Customer specific / HTTPS base URL:

https://<domainname>.rmissecure.com/_c/std/api/AttachCarrier.aspx?

 Replace <domainname> with the RMIS provided custom client domain name.

Generic HTTP base URL:

http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?

Required Arguments
There are 3 required static arguments that must ALWAYS be provided in the URL:

 clientID (the RMIS provided ID for the client)

 pwd (the RMIS provided API password for that client)
 attachMode (will either equal “Attach” or “Detach”)

The RMIS attach API allows the carrier that is to be attached to be identified several ways. Any of the
options below can be used, but ONE and ONLY ONE can be provided at a time. The carrier identifier can
be:

 MCNumber – the carrier’s DOT issued MC number

 DOTNumber – the carrier’s DOT issued US DOT number
 IntrastateNumber/IntrastateState – the combination of the carrier’s intrastate permit number
and state in which they operate. BOTH must be provided for intrastate carriers.
 InsuredID – the RMIS unique carrier ID.

Any of the above choices can be used, but ONE and ONLY ONE can be used at one time.

Note: the carrier identified using one of the above arguments MUST exist in the RMIS database for the
attach API to be successful. If the carrier does not exist in the RMIS system, please contact customer
service for assistance.

Note: if the carrier is ALREADY attached to the client in the RMIS system, the API will return an error.

4 RMIS Transportation – Attach/Detach API – 7/28/14

Optional Argument (ClientInsuredID)
Some clients choose to map a carrier in the RMIS system using their own proprietary identifier. Often
this is used to map a carrier in the RMIS system with a unique ID in the client’s own TMS system. (When
the MC#/DOT# is not used.)

Clients can attach carriers in the RMIS system using this unique ID. If used, the RMIS system will
maintain a SEPARATE mapping for each carrier / ClientInsured ID pair. For example, if a client attaches
the following carriers in the RMIS system using the API:

 Company: Test Trucking / MC# MC123456 / ClientsInsuredID: TEST

 Company: Test Trucking / MC# MC123456 / ClientsInsuredID: T123

The RMIS system will allow the client to attach the same carrier TWICE, once as TEST and once as T123.
The RMIS system will from that point forward monitor that single carrier’s information, but report it
back to the client under TEST and T123.

IMPORTANT: if in the future, the client wishes to DETACH that carrier, BOTH versions must be explicitly
detached. That means if the client wants to remove Test Trucking from being monitored, the client
must run the Detach API for both versions, as they are treated as separate in the RMIS system for that
client.

If the client does NOT wish to deal with adding multiple mappings for a single carrier, the
ClientInsuredID can be safely omitted, or left blank.

Examples of ClientInsuredID:

 Not used: ClientInsuredID=

 Used: ClientInsuredID=T123

Putting the Attach API Together

When calling the Attach API, simply concatenate the base URL, and then the required and optional
arguments separated by ampersands (“&”), and the key/values separated by equal signs (“=”).

Attach API Examples

Assume the following (be sure to replace the sample arguments when you test with your credentials):

 ClientID=12345
 Pwd=pass
 attachMode=Attach

Below are examples by carrier identifier type (and using the generic/http URL base), and NO
ClientInsuredID special mapping. The carrier IDs shown below are examples only.

5 RMIS Transportation – Attach/Detach API – 7/28/14

  By MC# (MC111111)
o http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=
pass&MCNumber=MC111111&clientsCarrierID=&attachMode=Attach
 By DOT# (US DOT 1111111)
o http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=
pass&DOTNumber=1111111&clientsCarrierID=&attachMode=Attach
 By Intrastate Permit (California, permit number 11111111)
o http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=
pass&IntrastateNumber=11111111&State=CA&clientsCarrierID=&attachMode=Attach
 By RMIS Insured ID (RMIS ID 999999)
o http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=
pass&insdID=999999&clientsCarrierID=&attachMode=Attach

Attach API example with ClientsCarrierID

To attach a carrier WITH custom client mapping, just add the associated ID in with the clientsCarrierID
argument.

o http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=
pass&MCNumber=111111&clientsCarrierID=TEST&attachMode=Attach

Note: the only difference is that we have added TEST as the unique client ID. It is possible to add the
same carrier multiple times as long as the clientsCarrierID is unique each time. The combination of the
carrier’s ID (MC/DOT/Intrastate Permit/RMIS ID) and the clientsCarrierID form a compound key in the
RMIS system.

Note: If a carrier is attached with a clientsCarrierID, then any future updates or Detaches MUST include
the same clientsCarrierID since it is now part of the carrier’s key in the RMIS system.

Note: If a carrier is ALREADY attached with the same carrier identifier AND clientsCarrierID, the API will
return an error.

Handling Attach API Return Values

After the URL is constructed and the HTTP POST/GET is performed, the API will return success or failure
XML.

The <Result> node will contain either “Attach SUCCESS” or “ERROR”. If ERROR, there will be an <Errors>
node containing the reason for the failure.

If successful, the <ConfirmationID> node will contain the ID of the added mapping.

Success Example:

<RMISAttachCarrier>
<Header>

6 RMIS Transportation – Attach/Detach API – 7/28/14

 <TimeStamp>7/20/2017 3:57:45 PM</TimeStamp>
<API>AttachCarrier</API>
<Result>Attach SUCCESS</Result>
<ConfirmationID>1628678</ConfirmationID>
</Header>
</RMISAttachCarrier>

Error Example #1 (bad password calling API)

<?xml version="1.0" ?>
<RMISAttachCarrier>
<Header>
<TimeStamp>10/20/2011 4:04:51 PM</TimeStamp>
<API>AttachCarrier</API>
<Result>ERROR</Result>
<Errors>
<Error>Password could not be validated.</Error>
</Errors>
</Header>
</RMISAttachCarrier>

Error Example #2 (API tried to add a carrier that does not exist in the RMIS system)

<?xml version="1.0" ?>

<RMISAttachCarrier>
<Header>
<TimeStamp>10/20/2013 4:04:22 PM</TimeStamp>
<API>AttachCarrier</API>
<Result>ERROR</Result>
<Errors>
<Error>MCNumber: MC000000 does not exist in the RMIS database.</Error>
</Errors>
</Header>
</RMISAttachCarrier>

Error Example #3 (API tried to add a carrier that already exists for this client in the RMIS system)

<?xml version="1.0" ?>

<RMISAttachCarrier>
<Header>
<TimeStamp>10/20/2013 4:03:30 PM</TimeStamp>
<API>AttachCarrier</API>
<Result>ERROR</Result>
<Errors>
<Error>InsdID: 175462 is already attached to client in the
database.</Error>
</Errors>
</Header>
</RMISAttachCarrier>

Building the Detach API URL

The Detach API is identical to the Attach API except the “attachMode” is set to Detach. (See Attach API
above for required fields and descriptions.) Any carrier that is already attached to the client that
matches the arguments will be REMOVED from monitoring by the RMIS system.

7 RMIS Transportation – Attach/Detach API – 7/28/14

CAUTION: for CRS+ customers, using the Detach API will make the carrier invisible to the client in the
RMIS system. If the client needs to preserve historical information about a carrier (agreements,
certificates, W9s, certification status, etc.) the client would be advised NOT to use the Detach API since
that information will be removed from their system.

Example DETACH API URLs (no clientsCarrierID mapping):

 By MC# (MC111111)
o http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=
pass&MCNumber=MC111111&clientsCarrierID=&attachMode=Detach
 By DOT# (US DOT 1111111)
o http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=
pass&DOTNumber=1111111&clientsCarrierID=&attachMode=Detach
 By Intrastate Permit (California, permit number 11111111)
o http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=
pass&IntrastateNumber=11111111&State=CA&clientsCarrierID=&attachMode=Detach
 By RMIS Insured ID (RMIS ID 999999)
o http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=
pass&insdID=999999&clientsCarrierID=&attachMode=Detach

The above samples will only work if there is NO clientCarrierID mappings. If clientCarrierID are present
in the client’s mapping of a carrier, then the related clientCarrierID MUST be provided. If there are
multiple clientCarrierIDs then they must be detached using MULTIPLE API calls.

Detach API example with ClientsCarrierID

To detach a carrier WITH custom client mapping, just add the associated ID in with the clientsCarrierID
argument.

o http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=
pass&MCNumber=111111&clientsCarrierID=TEST&attachMode=Detach

Handling Detach API Return Values

After the URL is constructed and the HTTP POST/GET is performed, the API will return success or failure
XML.

The <Result> node will contain either “Detach SUCCESS” or “ERROR”. If ERROR, there will be an <Errors>
node containing the reason for the failure.

If successful, the <ConfirmationID> node will contain the RMIS ID of the carrier that was detached.

Success Example:

<?xml version="1.0" ?>

<RMISAttachCarrier>

8 RMIS Transportation – Attach/Detach API – 7/28/14

 <Header>
<TimeStamp>10/20/2014 4:19:29 PM</TimeStamp>
<API>AttachCarrier</API>
<Result>Detach SUCCESS</Result>
<ConfirmationID>175462</ConfirmationID>
</Header>
</RMISAttachCarrier>

Detach Error Example:

In addition to the bad credential errors which will appear the same as with the Attach API, the Detach
API has an additional error case. If the API call attempts to remove a carrier or carrier/clientsCarrierID
that does NOT exist in the RMIS system, the following error will be returned:

<?xml version="1.0" ?>

<RMISAttachCarrier>
<Header>
<TimeStamp>10/20/2011 4:21:21 PM</TimeStamp>
<API>AttachCarrier</API>
<Result>ERROR</Result>
<Errors>
<Error>InsdID: 175462 has not attached to client yet.</Error>
</Errors>
</Header>
</RMISAttachCarrier>

Building the Update API URL

If a client wishes to update the clientsCarrierID on an existing record, the Update mode can be used. To
use this API mode, the carrier/clientsCarrierID must already exist in the RMIS system. For example: if
the carrier maps Test Trucking (MC@123456) with clientsCarrierID = TEST, but wants to update the
clientsCarrierID to “NEWID”.

The attachMode will be set to “Update”, and the new argument “clientsCarrierIDNew” must be supplied
with the ID that will replace the existing clientsCarrierID.

Example UPDATE API URL:

 http://api.registrymonitoring.com/_c/std/api/AttachCarrier.aspx?clientID=12345&pwd=pass&M
CNumber=111111&clientsCarrierID=TEST&clientsCarrierIDNew=NEWID&attachMode=Update

9 RMIS Transportation – Attach/Detach API – 7/28/14