isogeo_pysdk.api.routes_limitation module

Isogeo API v1 - API Routes to manage metadata limitations.

See: http://help.isogeo.com/api/complete/index.html

class isogeo_pysdk.api.routes_limitation.ApiLimitation(api_client=None)

Bases : object

Routes as methods of Isogeo API used to manipulate metadata limitations (CGUs).

create(metadata, limitation)

Add a new limitation to a metadata (= resource).

Paramètres:

metadata (Metadata) – metadata (resource) to edit
limitation (Limitation) – limitation object to create

Renvoie:

409 if a limitation with the same name already exists.

Type renvoyé:

Limitation or tuple

Example:

# retrieve metadata
md = isogeo.metadata.get(METADATA_UUID)
# create the limitation locally
new_limitation = Limitation(
    type="legal",
    restriction="patent",
    description="Do not use for commercial purpose.",
    )
# add it to the metadata
isogeo.metadata.limitations.create(md, new_limitation)

delete(limitation, metadata=None)

Delete a limitation from a metadata.

Paramètres:

limitation (Limitation) – Limitation model object to delete
metadata (Metadata) – parent metadata (resource) containing the limitation

get(metadata_id, limitation_id)

Get details about a specific limitation.

Paramètres:

metadata_id (str) – metadata UUID
limitation_id (str) – limitation UUID

Type renvoyé:

Limitation

Example:

>>> # get a metadata
>>> md = isogeo.metadata.get(METADATA_UUID)
>>> # list its limitations
>>> md_limitations = isogeo.metadata.limitations.listing(md)
>>> # get the first limitation
>>> limitation = isogeo.metadata.limitations.get(
    metadata_id=md._id,
    limitation_id=md_limitations[0].get("_id")
    )

listing(metadata)

Get limitations of a metadata.

Paramètres:: metadata (Metadata) – metadata (resource)
Type renvoyé:: list

update(limitation, metadata=None)

Update a limitation.

Paramètres:

limitation (Limitation) – Limitation model object to update
metadata (Metadata) – parent metadata (resource) containing the limitation

Type renvoyé:

Limitation