isogeo_pysdk.models.format module

Isogeo API v1 - Model of Format entity

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

class isogeo_pysdk.models.format.Format(_id=None, _tag=None, aliases=None, code=None, name=None, type=None, versions=None)

Bases: object

Formats are entities included as subresource into metadata for data history code.

Example

{
    "_id": string (uuid),
    "_tag": "format:dgn",
    "aliases": [
        "dgnv7",
        "dgnv8",
        "igds"
    ],
    "code": "dgn",
    "name": "DGN",
    "type": "dataset",
    "versions": [
        "v8",
        "V7",
        null
    ]
}

ATTR_CREA = {'aliases': <class 'list'>, 'code': <class 'str'>, 'name': <class 'str'>, 'type': <class 'str'>, 'versions': <class 'list'>}

ATTR_MAP = {}

ATTR_TYPES = {'_id': <class 'str'>, '_tag': <class 'str'>, 'aliases': <class 'list'>, 'code': <class 'str'>, 'name': <class 'str'>, 'type': <class 'str'>, 'versions': <class 'list'>}

property aliases: list

Gets the aliases of this Format.

Returns: The aliases of this Format.
Return type: list

property code: str

Gets the code of this Format.

Returns: The code of this Format.
Return type: str

property name: str

Gets the name of this Format.

Returns: The name of this Format.
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

property type: str

Gets the type of this Format.

Returns: The type of this Format.
Return type: str

property versions: list

Gets the versions of this Format.

Returns: The versions of this Format.
Return type: list