Handler package

Handler.auth module

The auth handler module: Authentication endpoint.

Provides the applications authentication REST method for admin authentication and admin clients JWT retrieval.

Src.Handler.auth.auth = <Blueprint 'auth'>

The auth endpoint blueprint

Src.Handler.auth.post_auth()

The REST method used to authenticate an admin user, in order to generate a JWT token for authentication with the applications JWT required endpoints.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Handler.create module

The create handler module: Create endpoint.

Provides the applications create REST methods for creating new database records within the Snomed and Amt SQLite tables.

Src.Handler.create.create = <Blueprint 'create'>

The create endpoint blueprint

Src.Handler.create.post_amt_create()

The REST method used to create a new AMT record within the Flask applications SQLite database. This REST method requires JWT authetication.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.create.post_snomed_create()

The REST method used to create a new SNOMED record within the Flask applications SQLite database. This REST method requires JWT authetication.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Handler.delete module

The delete handler module: Delete endpoint.

Provides the applications delete REST methods for deleting database records from both the Snomed and Amt SQLite tables.

Src.Handler.delete.delete = <Blueprint 'delete'>

The delete endpoint blueprint

Src.Handler.delete.delete_amt_by_filter()

The REST method used to delete an AMT record from the Flask applications SQLite database, by field filter/s. This REST method requires JWT authetication.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.delete.delete_amt_by_id()

The REST method used to delete an AMT record from the Flask applications SQLite database, by ID. This REST method requires JWT authetication.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.delete.delete_snomed_by_filter()

The REST method used to delete a SNOMED record from the Flask applications SQLite database, by field filter/s. This REST method requires JWT authetication.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.delete.delete_snomed_by_key()

The REST method used to delete a SNOMED record from the Flask applications SQLite database, by primary key. This REST method requires JWT authetication.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Handler.export module

The export handler module: Export endpoint.

Provides the applications export REST method for exporting the applications joined Amt and Snomed tables, as a CSV file.

Src.Handler.export.export = <Blueprint 'export'>

The export endpoint blueprint

Src.Handler.export.get_export()

The REST method used to export both the AMT and SNOMED distribution tables as a singularly joined and formatted table, that is then exported as a CSV file. This REST method requires JWT authentication.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Handler.search module

The search handler module: Search endpoint.

Provides the applications search REST methods for querying the Snomed and Amt SQLite tables based on primary key or field filters.

Src.Handler.search.get_amt_search()

The REST method used to query AMT records from within the Flask applications SQLite database, by field filter/s.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.search.get_amt_search_id()

The REST method used to query AMT records from within the Flask applications SQLite database, by ID.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.search.get_snomed_search()

The REST method used to query SNOMED records from within the Flask applications SQLite database, by field filter/s.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.search.get_snomed_search_key()

The REST method used to query Snomed records from within the Flask applications SQLite database, by primary key.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.search.get_unmapped_amt()

The REST method used to query AMT records from within the Flask applications SQLite database, that have no foreign key mapping to the SNOMED SQLite database table.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.search.search = <Blueprint 'search'>

The search endpoint blueprint

Handler.update module

The update handler module: Update endpoint.

Provides the applications update REST methods for updating records in the Snomed SQLite table. Updated records are queried based on primary key or field filters.

Src.Handler.update.put_update_AU_Substance_SCTID_by_filters()

The REST method used to update a SNOMED records AU_Substance_SCTID field from within the Flask applications SQLite database, by field filter/s.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.update.put_update_AU_Substance_SCTID_by_id()

The REST method used to update a SNOMED records AU_Substance_SCTID field from within the Flask applications SQLite database, by ID.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.update.put_update_Int_Substance_SCTID_by_filters()

The REST method used to update a SNOMED records Int_Substance_SCTID field from within the Flask applications SQLite database, by field filter/s.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.update.put_update_Int_Substance_SCTID_by_id()

The REST method used to update a SNOMED records Int_Substance_SCTID field from within the Flask applications SQLite database, by ID.

Returns:

The REST methods JSON response and response code

Return type:

JSON, Int

Src.Handler.update.update = <Blueprint 'update'>

The update endpoint blueprint