This page lists the terms and conventions used in this document.
IDs
MDI has chosen the “id” component of the URL to serve as a reference to specify
the specific entity the request is to act upon. For example: a GET request for
/api/clients/123/policies is interpreted as a request: GET CLIENTS POLICIES
where the id = 123. Unless specified otherwise, the id 123 reflects the key to
CLIENT for whom the policies will be retrieved. If the GET request was
/api/agents/123/policies, the id is interpreted as the key to AGENT. This
convention has been maintained throughout most of the implementation, and
exceptions will be noted where they occur.
URLs
The FIMMAS Data Services API was designed with flexibility in mind for our clients. This means that, while the API interfaces with external applications like a traditional API, the implementation is far from traditional. The actual URLs, or “routes”, are defined in the FIMMAS API Mapping Rules, not in the FIMMAS Data Services API itself. This way, a FIMMAS Administrator has freedom to implement custom API variations, without the need to install/upgrade the API from FIMMAS. This flexibility presents difficulty documenting the functionality, since the requests are not dictated by the API itself. To overcome this hurdle, we have chosen to document a set of “standard” or “recommended” URLS. Each will be accompanied by a reference to a FIMMAS process. Any time that process is invoked by the API, you can expect the behavior documented. Keep in mind, however, your URLs may be different.
| HTTP Method | URL Path | Portal ID | Request ID | FIMMAS Routine |
|---|---|---|---|---|
| GET | /api/clients/id/policies | indiv-portal | GET CLIENTS POLICIES | FWP GET CLIENTS POLICIES |
| GET | /api/clients/id/certs | group-portal | GET CLIENTS CERTS | FWP GET CLIENTS CERTIFICATES |
| GET | /api/clients/id/certs | indiv-portal | GET CLIENTS CERTS | FWP GET CLIENTS POLICIES |
In this example, the same URL (api/clients/id/certs) can be issued from two
different portals, and be directed to different FIMMAS Processes (GET CLIENTS
CERTIFICATES or GET CLIENTS POLICIES). Similarly, two different URL’s
(api/clients/id/policies or api/client/id/certs) could be directed to the SAME
FIMMAS Process (GET CLIENTS POLICIES)
This API Document will reference each request based on a recommended URL/Request. Your environment may be different, and we urge our clients to keep us informed of your implementation.