musicbrainz2.webservice.IWebService

All web service classes have to implement this and follow the method specifications.

get(self, entity, id_, include, filter, version)

Query the web service.

Using this method, you can either get a resource by id (using the id_ parameter, or perform a query on all resources of a type.

The filter and the id_ parameter exclude each other. If you are using a filter, you may not set id_ and vice versa.

Returns a file-like object containing the result or raises a WebServiceError or one of its subclasses in case of an error. Which one is used depends on the implementing class.

Parameters:

entity - a string containing the entity's name
id_ - a string containing a UUID, or the empty string
include - a tuple containing values for the 'inc' parameter
filter - parameters, depending on the entity
version - a string containing the web service version to use

Returns:

a file-like object

Raises:

WebServiceError - in case of errors

post(self, entity, id_, data, version)

source code

Submit data to the web service.