API

class route4me.api.Route4Me(key, headers={'Accept': '*/*', 'Accept-Encoding': 'identity, deflate, compress, gzip', 'User-Agent': 'python-sdk'}, redirects=True, verify_ssl=True, proxies={})

Bases: object

Route4Me Python SDK

__init__(key, headers={'Accept': '*/*', 'Accept-Encoding': 'identity, deflate, compress, gzip', 'User-Agent': 'python-sdk'}, redirects=True, verify_ssl=True, proxies={})

Initialize self. See help(type(self)) for accurate signature.

export_request_to_json(file_name)

Export resquest to JSON File :param file_name: :return:

export_result_to_json(file_name)

Export response to JSON File :param file_name: :return:

get(request_method)

Execute optimization :param request_method: :return: JSON

get_optimization(optimization_problem_id)

Get optimization given optimization_problem_id :param optimization_problem_id: :return:

parse_response()

Parse response and set it to Route4me instance :return:

re_optimization(optimization_id, data={})

Execute reoptimization :param optimization_id: :param data: :return: response as a object

run_optimization()

Run optimization and return response as an object. :return: response as an object

Data Structures

Enums and constants

route4me.constants.auto_enum(*sequential, **named)

Create enum :param sequential: :param named: :return:

route4me.constants.enum(**enums)

Create enums with custom values to help user set their params :param enums: :return:

API endpoints

Members

class route4me.members.Members(api)

Bases: route4me.base.Base

Members management.

__init__(api)

Members Instance :param api: :return:

app_purchase_user_license(**kwargs)

Application purchase user License :param kwargs: :return: API response content

get_api_key_users(**kwargs)

Get users taht belong to a given api_key using GET request :return: API response

get_users(**kwargs)

Get users using GET request :return: API response

member_authenticate(**kwargs)

Member Authenticate :param kwargs: :return: API response content

register(**kwargs)

Register Action :param kwargs: :return: API response content

validate_session(**kwargs)

Validate Session :param kwargs: :return: API response content

verify_device_license(**kwargs)

Verify User License :param kwargs: :return: API response content

webinar_registration(**kwargs)

Webinar Register :param kwargs: :return: API response content

Optimization

class route4me.optimization.Optimization(api)

Bases: route4me.base.Base

An Optimization Problem is a collection of addresses that need to be visited. This is distinct from a Route, which is a sequence of addresses that need to be visited by a single vehicle and a single driver in a fixed time period. Solving an Optimization Problem results in a number of routes.

__init__(api)

Optimization Instance :param api: :return:

delete_address_from_optimization(**kwargs)

Delete Address from an optimization using DELETE request :return: API response :raise: ParamValueException if required params are not present.

delete_optimization(**kwargs)

Delete optimization using DELETE request :return: API response :raise: ParamValueException if required params are not present.

get_optimization(**kwargs)

Get optimization using GET request :return: API response :raise: ParamValueException if required params are not present.

get_optimizations(**kwargs)

Get optimizations using GET request :return: API response :raise: ParamValueException if required params are not present.

update_optimization(**kwargs)

Update optimization using PUT request :return: API response :raise: ParamValueException if required params are not present.