isogeo_pysdk.models.invitation module

Isogeo API v1 - Model of Invitation entity

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

class isogeo_pysdk.models.invitation.Invitation(_created: str = None, _id: str = None, _modified: str = None, email: dict = None, expiresIn: str = None, group: str = None, role: bool = None)[source]

Bases: object

Invitations are CSW client entry-points.

Example:
{
    "_id": "6c7c9e0c63a943f79ba1e00766d0082d",
    "_created": "2019-07-25T09:23:37.0975771+00:00",
    "_modified": "2019-07-25T09:23:37.0975771+00:00",
    "role": "admin",
    "email": "prenom.nom@organisation.code",
    "expiresIn": 657364,
    "group": {
        "_id": "string (uuid)",
        "_tag": "owner:string (uuid)",
        "_created": "2019-05-07T15:11:08.5202923+00:00",
        "_modified": "2019-07-25T09:13:29.7858081+00:00",
        "contact": {
            "_id": "string (uuid)",
            "_tag": "contact:group:string (uuid)",
            "_deleted": false,
            "type": "group",
            "group": "Isogeo TEST",
            "available": false
        },
        "canCreateMetadata": true,
        "canCreateLegacyServiceLinks": false,
        "areKeywordsRestricted": false,
        "hasCswClient": false,
        "hasScanFme": false,
        "keywordsCasing": "lowercase"
    }
attr_crea = {'email': <class 'str'>, 'group': <class 'str'>, 'role': <class 'str'>}
attr_map = {}
attr_types = {'_created': <class 'str'>, '_id': <class 'str'>, '_modified': <class 'str'>, 'email': <class 'str'>, 'expiresIn': <class 'int'>, 'group': <class 'isogeo_pysdk.models.workgroup.Workgroup'>, 'role': <class 'str'>}
email

Gets the email of this Invitation.

Returns:The email of this Invitation.
Return type:str
expiresIn

Gets the expiresIn of this Invitation.

Returns:The expiresIn of this Invitation.
Return type:int
group

Gets the group of this Invitation.

Returns:The group of this Invitation.
Return type:Workgroup
role

Gets the role of this Invitation.

Returns:The role of this Invitation.
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