isogeo_pysdk.api.routes_share module
Isogeo API v1 - API Routes for Shares entities
See: http://help.isogeo.com/api/complete/index.html
- class isogeo_pysdk.api.routes_share.ApiShare(api_client=None)
Bases:
object
Routes as methods of Isogeo API used to manipulate shares.
- associate_application(share, application)
Associate a share with an application.
- Parameters
share (Share) – share model object to update
application (Application) – application object to associate
- Return type
- associate_catalog(share, catalog)
Associate a share with a catalog.
- associate_group(share, group)
Associate a group with a share of type ‘group’.
If the specified group is already associated, the response is still 204.
- create(workgroup_id, share={'_created': None, '_creator': (None,), '_id': None, '_modified': None, 'applications': None, 'catalogs': None, 'groups': None, 'name': None, 'rights': None, 'type': None, 'urlToken': None}, check_exists=1)
Add a new share to Isogeo.
- Parameters
0 = no check
1 = compare name [DEFAULT]
- Return type
- delete(share_id)
Delete a share from Isogeo database.
- dissociate_application(share, application)
Removes the association between the specified share and the specified application.
- Parameters
share (Share) – share model object to update
application (Application) – object to associate
- Return type
- dissociate_catalog(share, catalog)
Removes the association between the specified share and the specified catalog.
- dissociate_group(share, group)
Removes the association between the specified share and the specified group.
If the specified group is associated, the association is removed, Response is 204. If not, the Response is 500.
- exists(share_id)
Check if the specified share exists and is available for the authenticated user.
- get(share_id, include=('_abilities', 'groups'))
Returns details about a specific share.
- listing(workgroup_id=None, caching=1)
Get all shares which are accessible by the authenticated user OR shares for a workgroup.
- refresh_token(share)
Refresh the URL token of a share, used by Cartotheque, CSW, OpenCatalog.
- reshare(share, reshare=1)
Enable/disable the reshare option for the given share.
Only available for shares of type ‘group’.