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: list = None, _created: str = None, _id: str = None, _modified: str = None, _tag: str = None, areKeywordsRestricted: bool = None, canCreateLegacyServiceLinks: bool = None, canCreateMetadata: bool = None, code: str = None, contact: isogeo_pysdk.models.contact.Contact = None, hasCswClient: bool = None, hasScanFme: bool = None, keywordsCasing: str = None, limits: dict = None, metadataLanguage: str = None, themeColor: str = None)[source]

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'
}
areKeywordsRestricted

Gets the areKeywordsRestricted of this Workgroup.

Returns:The areKeywordsRestricted of this Workgroup.
Return type:str
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'>, 'keywordsCasing': <class 'str'>, 'limits': <class 'dict'>, 'metadataLanguage': <class 'str'>, 'themeColor': <class 'str'>}

Gets the canCreateLegacyServiceLinks of this Workgroup.

Returns:The canCreateLegacyServiceLinks of this Workgroup.
Return type:str
canCreateMetadata

Gets the canCreateMetadata of this Workgroup.

Returns:The canCreateMetadata of this Workgroup.
Return type:str
code

Gets the code of this Workgroup.

Returns:The code of this Workgroup.
Return type:str
contact

Gets the contact of this Workgroup.

Returns:The contact of this Workgroup.
Return type:dict
hasCswClient

Gets the hasCswClient of this Workgroup.

Returns:The hasCswClient of this Workgroup.
Return type:str
keywordsCasing

Gets the keywordsCasing of this Workgroup.

Returns:The keywordsCasing of this Workgroup.
Return type:str
limits

Gets the limits of this Workgroup.

Returns:The limits of this Workgroup.
Return type:dict
metadataLanguage

Gets the metadataLanguage of this Workgroup.

Returns:The metadataLanguage of this Workgroup.
Return type:str
name

Shortcut to get the name of the workgroup.

themeColor

Gets the themeColor of this Workgroup.

Returns:The themeColor of this Workgroup.
Return type:str
to_dict() → dict[source]

Returns the model properties as a dict.

to_dict_creation() → dict[source]

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

to_str() → str[source]

Returns the string representation of the model.