REST API Documentation

This page documents the current views implementing the REST endpoints of the openNPL server.

The overall structure is as follows:

  • api_root (overall API root)

  • npl_api_root (npl data API root)

    • npl_DATA_MODEL_api collections of DATA_MODEL

    • npl_DATA_MODEL_detail instances of DATA_MODEL

Todo

Some models only implement collective (list) views, detailed views to be implemented in due course. :github:22:

openNPL.views.opennpl_api_root(request, *args, **kwargs)

Returns a list of all active API endpoints in an OpenNPL instance, grouped by functionality:

  • The NPL Data Endpoints implement a REST API to EBA Templated NPL Data

  • The SFLP Data Endpoints implement a REST API to Fannie Mae Mortgage Data