isogeo_pysdk.models.catalog module¶
Isogeo API v1 - Model of Catalog entity
See: http://help.isogeo.com/api/complete/index.html#definition-catalog
-
class
isogeo_pysdk.models.catalog.
Catalog
(_abilities=None, _created=None, _id=None, _modified=None, _tag=None, code=None, count=None, name=None, owner=None, scan=None)¶ Bases:
object
Catalogs are entities used to organize and shares metadata of a workgroup.
Example: { '$scan': boolean, '_abilities': array, '_created': string (datetime), '_id': string (uuid), '_modified': string (datetime), '_tag': string, 'code': string, 'count': integer, 'name': string, 'owner': { '_created': string (datetime), '_id': string (uuid), '_modified': string (datetime), '_tag': string, 'areKeywordsRestricted': boolean, 'canCreateLegacyServiceLinks': boolean, 'canCreateMetadata': boolean, 'contact': { '_deleted': boolean, '_id': string (uuid), '_tag': string, 'addressLine1': string, 'addressLine2': string, 'available': boolean, 'city': string, 'countryCode': string, 'email': string (email), 'fax': string, 'name': string, 'phone': string, 'type': string, 'zipCode': string }, 'hasCswClient': boolean, 'hasScanFme': boolean, 'keywordsCasing': string, 'metadataLanguage': string } }
-
ATTR_CREA
= {'code': <class 'str'>, 'name': <class 'str'>, 'scan': <class 'bool'>}¶
-
ATTR_MAP
= {'scan': '$scan'}¶
-
ATTR_TYPES
= {'_abilities': <class 'list'>, '_created': <class 'str'>, '_id': <class 'str'>, '_modified': <class 'str'>, '_tag': <class 'str'>, 'code': <class 'str'>, 'count': <class 'int'>, 'name': <class 'str'>, 'owner': <class 'isogeo_pysdk.models.workgroup.Workgroup'>, 'scan': <class 'bool'>}¶
-
classmethod
clean_attributes
(raw_object)¶ Renames attributes wich are incompatible with Python (hyphens…).
See related issue: https://github.com/isogeo/isogeo-api-py-minsdk/issues/82
-
code
¶ Gets the code of this Catalog.
Returns: The code of this Catalog. Return type: str
-
count
¶ Gets the count of this Catalog.
Returns: The count of this Catalog. Return type: str
-
name
¶ Gets the name of this Catalog.
Returns: The name of this Catalog. Return type: str
-
owner
¶ Gets the owner of this Catalog. # noqa: E501.
Returns: The owner of this Catalog. # noqa: E501 Return type: Workgroup
-
scan
¶ Gets the scan of this Catalog.
Returns: The scan of this Catalog. Return type: bool
-
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
-