isogeo_pysdk.models.specification module

Isogeo API v1 - Model of Specification entity

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

class isogeo_pysdk.models.specification.Specification(_abilities=None, _id=None, _tag=None, count=None, link=None, name=None, owner=None, published=None)

Bases: object

Specifications are entities defining rules of data creation.

Example

{
    '_abilities': [],
    '_id': 'string (uuid)',
    '_tag': 'specification:isogeo:string (uuid)',
    'count': int,
    'link': string,
    'name': string,
    'published': '2016-06-30T00:00:00'
}

ATTR_CREA = {'link': <class 'str'>, 'name': <class 'str'>, 'published': <class 'str'>}

ATTR_MAP = {}

ATTR_TYPES = {'_abilities': <class 'str'>, '_id': <class 'str'>, '_tag': <class 'str'>, 'count': <class 'int'>, 'link': <class 'str'>, 'name': <class 'str'>, 'owner': <class 'dict'>, 'published': <class 'str'>}

property count: int

Gets the id of this Specification.

Returns: The id of this Specification.
Return type: str

property isLocked: bool

Shortcut to know if the Specification is owned by Isogeo or a workgroup.

Return type

bool

Returns

None if tag is None too
True if the specification is owned by Isogeo = locked
False if the specification is owned by a workgroup = not locked

property link: str

Gets the link (URL) of this Specification.

Returns: The link (URL) of this Specification.
Return type: str

property name: str

Gets the id of this Specification.

Returns: The id of this Specification.
Return type: str

property owner

Gets the owner of this Specification.

Returns: The owner of this Specification.
Return type: Workgroup

property published: str

Gets the zip (postal) code of this Specification.

Returns: The zip (postal) code of this Specification.
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