collecting_society_web.views.api.v1 package

Submodules

collecting_society_web.views.api.v1.artists module

class collecting_society_web.views.api.v1.artists.Artist(request, context=None)

Bases: ResourceBase

artist_data(sorted_scores)

Returns the properties of the found artists.

Parameters:

[ (sorted_scores) – native (C3S) code, i.e “C0000000123” together with a score certainty in %, derived from the query parameter(s) (to be returned in the result dict)

Returns:

artist record (Dictionary) including the score

Exceptions:

HTTPNotFound, if artist can’t be found from the code

collection_get(permission='view')

Returns the properties of a specific artist that is identified using multiple identifiers, which are provided as querystring parameters.

Example URL:

http://api.collecting_society.test/v1/artists? native_id=C0000000001&artist=Registered Name 001 &title=Title of Song 001&ISRC=DE-A00-20-00001&ISWC=T-000.000.001-C

get(permission='view')

Returns the properties of a specific artist that is identified using the common REST scheme with the native code following the artist object.

Example URL:

http://api.collecting_society.test/v1/artists/C0000012345

class collecting_society_web.views.api.v1.artists.ArtistField(*args, **kw)

Bases: SchemaNode

missing = ''

name = 'artist'

oid = 'artist'

schema_type

alias of String

validator = <colander.Length object>

class collecting_society_web.views.api.v1.artists.ArtistGetSchema(*args, **kw)

Bases: Schema

class collecting_society_web.views.api.v1.artists.BodySchema(*args, **kw)

Bases: Schema

Create a body schema for our requests

class collecting_society_web.views.api.v1.artists.CodeField(*args, **kw)

Bases: SchemaNode

name = 'native_id'

oid = 'native_id'

schema_type

alias of String

validator = <colander.Regex object>

class collecting_society_web.views.api.v1.artists.ResponseSchema(*args, **kw)

Bases: Schema

Create a response schema for our 200 responses

class collecting_society_web.views.api.v1.artists.UserResource(request)

Bases: object

collecting_society_web.views.api.v1.artists.deferred_idspace_schemas_node(request)

collecting_society_web.views.api.v1.artists.deferred_querystring_validator(request, schema=None, deserializer=None, **kwargs)

Workaround to trick cornice into digesting a deferred schemas_node as root node.

collecting_society_web.views.api.v1.creations module

class collecting_society_web.views.api.v1.creations.ArtistField(*args, **kw)

Bases: SchemaNode

missing = ''

name = 'artist'

oid = 'artist'

schema_type

alias of String

validator = <colander.Length object>

class collecting_society_web.views.api.v1.creations.BodySchema(*args, **kw)

Bases: Schema

Create a body schema for our requests

class collecting_society_web.views.api.v1.creations.CodeField(*args, **kw)

Bases: SchemaNode

name = 'native_id'

oid = 'native_id'

schema_type

alias of String

validator = <colander.Regex object>

class collecting_society_web.views.api.v1.creations.Creation(request, context=None)

Bases: ResourceBase

collection_get(permission='view')

Returns the properties of a specific creation that is identified using multiple identifiers, which are provided as querystring parameters.

Example URL:

http://api.collecting_society.test/v1/creations? native_id=C0000000001&artist=Registered Name 001 &title=Title of Song 001&ISRC=DE-A00-20-00001&ISWC=T-000.000.001-C

creation_data(sorted_scores)

Returns the properties of the found creations.

Parameters:

[ (sorted_scores) – native (C3S) code, i.e “C0000000123” together with a score certainty in %, derived from the query parameter(s) (to be returned in the result dict)

Returns:

creation record (Dictionary) including the score

Exceptions:

HTTPNotFound, if creation can’t be found from the code

get(permission='view')

Returns the properties of a specific creation that is identified using the common REST scheme with the native code following the creation object.

Example URL:

http://api.collecting_society.test/v1/creations/C0000012345

class collecting_society_web.views.api.v1.creations.CreationGetSchema(*args, **kw)

Bases: Schema

class collecting_society_web.views.api.v1.creations.ResponseSchema(*args, **kw)

Bases: Schema

Create a response schema for our 200 responses

class collecting_society_web.views.api.v1.creations.TitleField(*args, **kw)

Bases: SchemaNode

missing = ''

name = 'title'

oid = 'title'

schema_type

alias of String

validator = <colander.Length object>

class collecting_society_web.views.api.v1.creations.UserResource(request)

Bases: object

collecting_society_web.views.api.v1.creations.deferred_idspace_schemas_node(request)

collecting_society_web.views.api.v1.creations.deferred_querystring_validator(request, schema=None, deserializer=None, **kwargs)

Workaround to trick cornice into digesting a deferred schemas_node as root node.

collecting_society_web.views.api.v1.releases module

class collecting_society_web.views.api.v1.releases.BodySchema(*args, **kw)

Bases: Schema

Create a body schema for our requests

class collecting_society_web.views.api.v1.releases.CodeField(*args, **kw)

Bases: SchemaNode

name = 'native_id'

oid = 'native_id'

schema_type

alias of String

validator = <colander.Regex object>

class collecting_society_web.views.api.v1.releases.Release(request, context=None)

Bases: ResourceBase

collection_get(permission='view')

Returns the properties of a specific release that is identified using multiple identifiers, which are provided as querystring parameters.

Example URL:

http://api.collecting_society.test/v1/releases? native_id=R0000000001&release=Release 001 &GRid=A1-ABCDE-0000000001-M&EAN/UPC=0000000000001

get(permission='view')

Returns the properties of a specific release that is identified using the common REST scheme with the native code following the release object.

Example URL:

http://api.collecting_society.test/v1/releases/R0000012345

release_data(sorted_scores)

Returns the properties of the found releases.

Parameters:

[ (sorted_scores) – native (C3S) code, i.e “R0000000123” together with a score certainty in %, derived from the query parameter(s) (to be returned in the result dict)

Returns:

release record (Dictionary) including the score

Exceptions:

HTTPNotFound, if release can’t be found from the code

class collecting_society_web.views.api.v1.releases.ReleaseField(*args, **kw)

Bases: SchemaNode

missing = ''

name = 'release'

oid = 'release'

schema_type

alias of String

validator = <colander.Length object>

class collecting_society_web.views.api.v1.releases.ReleaseGetSchema(*args, **kw)

Bases: Schema

class collecting_society_web.views.api.v1.releases.ResponseSchema(*args, **kw)

Bases: Schema

Create a response schema for our 200 responses

class collecting_society_web.views.api.v1.releases.UserResource(request)

Bases: object

collecting_society_web.views.api.v1.releases.deferred_idspace_schemas_node(request)

collecting_society_web.views.api.v1.releases.deferred_querystring_validator(request, schema=None, deserializer=None, **kwargs)

Workaround to trick cornice into digesting a deferred schemas_node as root node.

Module contents