1.3. backendapp.api.baseresource

An API consists of resources that inherit from BaseResource.

class backendapp.api.baseresource.BaseResource(Schema, service)

Contains class variables common to all resources.

__init__(Schema, service)

Constructor for the BaseResource class.

Parameters

• Schema – Marshamallow schema for the model associated with the service.

• service – for creating and retrieving model instances.

class backendapp.api.baseresource.MultipleResource(Schema, service)

A Resource that appends to or returns a list of model instances.

This is used to post one capture or return a list of tags.

__init__(Schema, service)

Constructor for the BaseResource class.

Parameters

• Schema – Marshamallow schema for the model associated with the service.

• service – for creating and retrieving model instances.

get_filtered(reqfilterlist=[], optfilterlist=[])

Get a list of resources filtered by requiredlist and optionally by optlist. Returns:

post()

Instantiate a model instance and return it.

class backendapp.api.baseresource.SingleResource(Schema, service)

A Resource that returns or deletes one model instance.

It is used to retrieve one capture as JSON or delete one tag.

__init__(Schema, service)

Constructor for the BaseResource class.

Parameters

• Schema – Marshamallow schema for the model associated with the service.

• service – for creating and retrieving model instances.

delete(id)

Delete a model instance.

Parameters

id – model instance ID to delete.

get(id)

Return a resource schema for the model instance

Parameters

id – model instance ID.