isogeo_pysdk.models.workgroup module

Isogeo API v1 - Model of Workgroup entity

See: http://help.isogeo.com/api/complete/index.html#definition-workgroup

class isogeo_pysdk.models.workgroup.Workgroup(_abilities=None, _created=None, _id=None, _modified=None, _tag=None, areKeywordsRestricted=None, canCreateLegacyServiceLinks=None, canCreateMetadata=None, code=None, contact=None, hasCswClient=None, hasScanFme=None, keywordsCasing=None, limits=None, metadataLanguage=None, themeColor=None)

Bases: object

Workgroups are entities containing metadata.

Example

{
    '_abilities': [
        'group:manage',
        'group:update'
    ],
    '_created': '2015-05-21T12:08:16.4295098+00:00',
    '_id': '32f7e95ec4e94ca3bc1afda960003882',
    '_modified': '2018-12-27T10:47:28.7880956+00:00',
    '_tag': 'owner:32f7e95ec4e94ca3bc1afda960003882',
    'areKeywordsRestricted': False,
    'canCreateLegacyServiceLinks': True,
    'canCreateMetadata': True,
    'contact': {
        '_deleted': False,
        '_id': '2a3aefc4f80347f590afe58127f6cb0f',
        '_tag': 'contact:group:2a3aefc4f80347f590afe58127f6cb0f',
        'addressLine1': '26 rue du faubourg Saint-Antoine',
        'addressLine2': '4éme étage',
        'addressLine3': 'bouton porte',
        'available': False,
        'city': 'Paris',
        'countryCode': 'FR',
        'email': 'dev@isogeo.com',
        'fax': '33 (0)9 67 46 50 06',
        'name': 'Isogeo Test',
        'phone': '33 (0)9 67 46 50 06',
        'type': 'group',
        'zipCode': '75012'
    },
    'hasCswClient': True,
    'hasScanFme': True,
    'keywordsCasing': 'lowercase',
    'limits': {
        'canDiffuse': False,
        'canShare': True,
        'Workgroups': {
            'current': 1,
            'max': -1
        },
        'resources': {
            'current': 2,
            'max': 20
        },
        'upload': {
            'current': 0,
            'max': 1073741824
        },
        'users': {
            'current': 1,
            'max': 2}
        },
    'metadataLanguage': 'fr',
    'themeColor': '#4499A1'
}
ATTR_CREA = {'canCreateLegacyServiceLinks': <class 'bool'>, 'canCreateMetadata': <class 'bool'>, 'contact': <class 'isogeo_pysdk.models.contact.Contact'>, 'metadataLanguage': <class 'str'>}
ATTR_MAP = {'contact': ['contact.addressLine1', 'contact.addressLine2', 'contact.addressLine3', 'contact.city', 'contact.countryCode', 'contact.email', 'contact.fax', 'contact.name', 'contact.phone', 'contact.zipCode']}
ATTR_TYPES = {'_abilities': <class 'list'>, '_created': <class 'str'>, '_id': <class 'str'>, '_modified': <class 'str'>, '_tag': <class 'str'>, 'areKeywordsRestricted': <class 'bool'>, 'canCreateLegacyServiceLinks': <class 'bool'>, 'canCreateMetadata': <class 'bool'>, 'code': <class 'str'>, 'contact': <class 'isogeo_pysdk.models.contact.Contact'>, 'hasCswClient': <class 'bool'>, 'hasScanFme': <class 'bool'>, 'keywordsCasing': <class 'str'>, 'limits': <class 'dict'>, 'metadataLanguage': <class 'str'>, 'themeColor': <class 'str'>}
admin_url(url_base='https://app.isogeo.com')

Returns the administration URL (https://app.isogeo.com) for this group.

Parameters

url_base (str) – base URL of admin site. Defaults to: https://app.isogeo.com. Can also be https://manage.isogeo.com.

Return type

str

property areKeywordsRestricted: str

Gets the areKeywordsRestricted of this Workgroup.

Returns

The areKeywordsRestricted of this Workgroup.

Return type

str

Gets the canCreateLegacyServiceLinks of this Workgroup.

Returns

The canCreateLegacyServiceLinks of this Workgroup.

Return type

str

property canCreateMetadata: bool

Gets the canCreateMetadata of this Workgroup.

Returns

The canCreateMetadata of this Workgroup.

Return type

str

property code: str

Gets the code of this Workgroup.

Returns

The code of this Workgroup.

Return type

str

property contact: isogeo_pysdk.models.contact.Contact

Gets the contact of this Workgroup.

Returns

The contact of this Workgroup.

Return type

dict

property hasCswClient: bool

Gets the hasCswClient of this Workgroup.

Returns

The hasCswClient of this Workgroup.

Return type

bool

property hasScanFme: bool

Find out if the group has access to the Scan.

Returns

The hasScanFme value of this Workgroup.

Return type

bool

property keywordsCasing: str

Gets the keywordsCasing of this Workgroup.

Returns

The keywordsCasing of this Workgroup.

Return type

str

property limits: dict

Gets the limits of this Workgroup.

Returns

The limits of this Workgroup.

Return type

dict

property metadataLanguage: str

Gets the metadataLanguage of this Workgroup.

Returns

The metadataLanguage of this Workgroup.

Return type

str

property name: str

Shortcut to get the name of the workgroup.

Return type

str

property themeColor: str

Gets the themeColor of this Workgroup.

Returns

The themeColor of this Workgroup.

Return type

str

to_dict()

Returns the model properties as a dict.

Return type

dict

to_dict_creation()

Returns the model properties as a dict structured for creation purpose (POST)

Return type

dict

to_str()

Returns the string representation of the model.

Return type

str