Skip to content

Latest commit

 

History

History
148 lines (108 loc) · 6.9 KB

DataExtractsApi.md

File metadata and controls

148 lines (108 loc) · 6.9 KB
Raw

yodlee.DataExtractsApi

All URIs are relative to http://localhost

Method HTTP request Description
get_data_extracts_events GET /dataExtracts/events Get Events
get_data_extracts_user_data GET /dataExtracts/userData Get userData

get_data_extracts_events

DataExtractsEventResponse get_data_extracts_events(event_name, from_date, to_date)

Get Events

The get extracts events service is used to learn about occurrences of data extract related events. This service currently supports only the DATA_UPDATES event.
Passing the event name as DATA_UPDATES provides information about users for whom data has been modified in the system for the specified time range. To learn more, please refer to the <a href="https://developer.yodlee.com/docs/api/1.1/DataExtracts\">dataExtracts page.
You can retrieve data in increments of no more than 60 minutes over the period of the last 7 days from today's date.
This service is only invoked with either admin access token or a cobrand session.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.DataExtractsApi(api_client)
    event_name = 'event_name_example' # str | Event Name
from_date = 'from_date_example' # str | From DateTime (YYYY-MM-DDThh:mm:ssZ)
to_date = 'to_date_example' # str | To DateTime (YYYY-MM-DDThh:mm:ssZ)

    try:
        # Get Events
        api_response = api_instance.get_data_extracts_events(event_name, from_date, to_date)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataExtractsApi->get_data_extracts_events: %s\n" % e)

Parameters

Name Type Description Notes
event_name str Event Name
from_date str From DateTime (YYYY-MM-DDThh:mm:ssZ)
to_date str To DateTime (YYYY-MM-DDThh:mm:ssZ)

Return type

DataExtractsEventResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8

HTTP response details

Status code Description Response headers
200 OK -
400 Y800 : Invalid value for fromDate.fromDate cannot be greater than current time<br>Y800 : Invalid value for toDate.toDate cannot be greater than current time<br>Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days<br>Y800 : Invalid value for fromDate.fromDate cannot be greater than toDate. -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_data_extracts_user_data

DataExtractsUserDataResponse get_data_extracts_user_data(from_date, login_name, to_date)

Get userData

The get user data service is used to get a user's modified data for a particular period of time for accounts, transactions, holdings, and provider account information.
The time difference between fromDate and toDate fields cannot be more than 60 minutes.
By default, pagination is available for the transaction entity in this API. In the first response, the API will retrieve 500 transactions along with other data. The response header will provide a link to retrieve the next set of transactions.
In the response body of the first API response, totalTransactionsCount indicates the total number of transactions the API will retrieve for the user.
This service is only invoked with either admin access token or a cobrand session.
Refer to <a href="https://developer.yodlee.com/docs/api/1.1/DataExtracts\">dataExtracts page for more information.

Note:

  • This service supports the localization feature and accepts locale as a header parameter.

    • Example

    from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.DataExtractsApi(api_client)
    from_date = 'from_date_example' # str | From DateTime (YYYY-MM-DDThh:mm:ssZ)
login_name = 'login_name_example' # str | Login Name
to_date = 'to_date_example' # str | To DateTime (YYYY-MM-DDThh:mm:ssZ)

    try:
        # Get userData
        api_response = api_instance.get_data_extracts_user_data(from_date, login_name, to_date)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataExtractsApi->get_data_extracts_user_data: %s\n" % e)

    Parameters

    Name Type Description Notes
    from_date str From DateTime (YYYY-MM-DDThh:mm:ssZ)
    login_name str Login Name
    to_date str To DateTime (YYYY-MM-DDThh:mm:ssZ)

    Return type

    DataExtractsUserDataResponse

    Authorization

    No authorization required

    HTTP request headers

    • Content-Type: Not defined
    • Accept: application/json;charset=UTF-8

    HTTP response details

    Status code Description Response headers
    200 OK -
    400 Y800 : Invalid value for eventName<br>Y821 : Data update event not supported<br>Y800 : Invalid value for fromDate.fromDate cannot be greater than current time<br>Y800 : Invalid value for toDate.toDate cannot be greater than current time<br>.Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days<br>Y800 : Invalid value for fromDate.fromDate can not be greater than toDate<br>Y800 : Invalid value for loginName -
    401 Unauthorized -
    404 Not Found -

    [Back to top] [Back to API list] [Back to Model list] [Back to README]