insured

Change policy billing schedule

Code
Parameters
----------
policy_id : str, required
    Policy id
billing_schedule_id : str, required
    Schedule to switch to
policy_term_id : str, optional
    Policy Term whose billing schedule is being changed

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages

Retrieves all contacts similar to contact_id If

Code
Parameters
----------
contact_id : str, required
    Contact id to match
ssn_only_check : bool
    Flag if SSN-only search should be applied
contact_ids_to_check : list of str
    contacts to compare, if provided. Otherwise search will be performed for all named insureds in DB

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::
        {
            "has_dob": true,
            "has_ssn": true,
            "result": [
                {
                    "hit_by_ssn": true,
                    "id": __uuid__
                },
                {
                    "hit_by_dob_and_phone": true,
                    "id": __uuid__
                }, ...
            ]
        }

Return agents and agencies related to insured's policies

Code
Parameters
----------
contact_id : str, required
    UUID of an existing Insured

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    Agents/Agencies data
    {
    "agents": {},
    "agencies": {
        "agency_id1": {
            "photo_id": null,
            "addresses": [
                {
                    "address_line2": null,
                    "address_city": "WELLSTON",
                    "address_line1": "PO BOX 314",
                    "type_label": null,
                    "date_updated": null,
                    "address_country": "USA",
                    "address_county": "",
                    "contact_id": "8a403b5b-fb57-4b29-9524-53f431651da6",
                    "longitude": null,
                    "attention": null,
                    "address_state": "OK",
                    "latitude": null,
                    "type": "Mailing/Billing",
                    "id": "6d5cc731-c5fb-11e5-8667-12a91c8c3ac7",
                    "address_zip": "74881"
                }
            ],
            "phones": [
                {
                    "date_updated": null,
                    "phone": "(405)356-2477",
                    "type": "Work",
                    "id": "6d4a9d49-c5fb-11e5-8667-12a91c8c3ac7",
                    "contact_id": "8a403b5b-fb57-4b29-9524-53f431651da6"
                }
            ],
            "emails": [
                {
                    "date_updated": null,
                    "type": "Work",
                    "id": "1261aac2-aad2-486f-9509-1b59f66dc58c",
                    "contact_id": "8a403b5b-fb57-4b29-9524-53f431651da6",
                    "email": "steffenson06@sbcglobal.net"
                },

            ],
            "id": "8a403b5b-fb57-4b29-9524-53f431651da6",
            "name": "Steffenson Ins. Agy. [356]"
        }
    }
}

Retrieves insured data accroding to input param.

Code
Parameters
----------
contact_id : str
    Filter notes by contact_id
policy_params : dict
    Values that will be sent to appropriate function
filter_values : array
    Array of strings defining values list to return. For all values should be empty []
    F.e. ['contact', 'policies']

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::
        {
            "contact": {},
            "policies": "{}"
        }

Retrieves all contacts having 'Insured Portal User' role

Code
:return:
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list of dicts
    The data response having the form:
    ::
        [{
            "id": __contact_id__,
            "name": __contact_name__
        },...]

Retrieve contact information for carrier

Code
Parameters
----------

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict contains carrier's contact data

Get property data

Code
Parameters
----------
property_id : str, required
    UUID of an existing Property instance

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    A dict containing results

Check if email not belong to another contact

Code
Parameters
----------
email : str
    Email to check
contact_id : str
    Contact id that we want to assign email

Returns
-------
success : bool
    True if available, false if not
messages : list of str
    List of human-readable error messages

Create claim.

Code
Parameters
----------
policy_id : str, required
    Policy id
property_id : str, optional
    Property id

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict containing claim details

Get contact data

Code
Parameters
----------
contact_id : str, required
    UUID of an existing Contact instance
additional_policy_list : list
    UUID list of additional policy IDs to be retrieved
include_canceled: bool
    Optional, whether to retrieve policies that are canceled

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    A dict containing contact

Updates file metadata

Code
Parameters
----------
file_id : str
    Updated File id
metadata : dict
    Dict that describes new metadata
    {
        'update': {key:value, ...},   # metadata values to be updates
        'delete': [key1, key2,...],    # metadata values to be deleted
        'key':value ,   # metadata to update
    }

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages

Updates file received_meta_data keyword 'preferred'

Code
For all resource's photos 'preferred' metadata key set to False except photo with file_id

Parameters
----------
file_id : str, required
    Updated File id
reference_id : str, required
    Insured id

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages

Updates file received_meta_data keyword 'caption'

Code
Parameters
----------
file_id : str, required
    Updated File id
caption : str, optional
    'Caption' metadata value

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages

Submits the claim to the carrier

Code
Parameters
----------
claim_id : str, required
    Claim id

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages

Stores the loss date/description for a given claim

Code
Parameters
----------
claim_id: str, required
    Claim id
loss_date: str, required
    YYYY_MM-DD Loss Date
description: str, required
    Description
additional_information: dict, optional
    Additional information for the claim submission, with arbitrary keys and values(as strings), like:
    ::
        {
            "Insured Contact Number": "+1 (650) 321-1234",
            "Device ID": "0fe6a7bf-bca7-4757-825c-7cc9bf90cfc0"
        }
Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages

update_contact_email_notices_flag

Updates contact values

Code
Parameters
----------
contact_id : str
    Contact id
contact_name : str
    Name to update
contact_photo : basestring
    Photo in base64 format
contact_addresses : list of dicts
    List of address dicts
contact_phones : list of dicts
    List of phones dicts
contact_emails : list of dicts
    List of emails dicts
dry_run : bool
    False for apply changes, True for compare without apply

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict containing changes
    {
    'name_updated': name_updated,
    'new_addresses': new_addresses,
    'updated_addresses': updated_addresses,
    'new_phones': new_phones,
    'updated_phones': updated_phones,
    'new_emails': new_emails,
    'updated_emails': updated_emails,
    'updated_photo': update_photo
}

Uploads claim/property user's photo. User's and agent's photos stored in different folders.

Code
Agent's photos stored in None folder and user's photos stored in %INSURED_UPLOAD_PHOTOS_DIR_NAME%
This way on claim/property retrieve we can distinguish user/agent photos

Parameters
----------
file_type : str, required
    either one of 'properties' or 'claims'
reference_id : str, required
    reference id pointing to claim or property id related to file
photo_as_base64 : basestring, required
    photo as a data URI string -- ex: 'data:image/gif;base64,abcdefghij...'
filename : str, required
    original filename of uploaded file
mimetype : str
    mimetype of uploaded file

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::
        {
            "file_id": uploaded_file_id
        }