Back to API references

SOAP API method Import_interval

Description

If this is a periodic import, this method returns the interval at which this periodic import should run, otherwise it returns false. Note that the interval is only meaningful if there is no schedule.

Parameters

Name Type Description
id * int Unique identifier (id) of the object Import. The method only applies to the import with this id.
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
dateinterval Structure of type 'dateinterval'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'dateinterval'

Name Type Description
count int The count of the dateinterval.
unit string The unit of the dateinterval.