SOAP API method Database_createImport

Description
Create an import on the database. An import is to fill the database by an external file. Mostly it is a tab-delimted file. Via the API it is not allowed to call this method with the source 'file://'.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Database. The method only applies to the database with this id.
Parameter 'name' : string
Name of the import. This is the name by which the users can identify the import: for example the original filename
Parameter 'source' : string
Source of the import, this is a url of the form "file://" if this import comes from a file, and a url if this import comes from a remote location. Via the API it is not allowed to call this method with the source 'file://'. Is the url isn't set the data has to be added using the addData method.
Parameter 'delimiter' : string
Delimiter in the file, default is tab
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'import' : Structure of type 'import'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'import'
This structure import was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the import.
Property 'status' : string
The status of the import.
Property 'laststarttime' : timestamp
The time when the import was started.
Property 'nextstarttime' : timestamp
The time when the next import starts.
Property 'strange' : boolean
Is the input 'strange'?.
Property 'type' : string
The type of the import.
Property 'ignoreemptyfields' : boolean
Should empty fields be ignored in the import?
Property 'removemissing' : boolean
Should the missing profiles or subprofiles be removed?.
Property 'name' : string
The name of the import.
Property 'repeatable' : boolean
Can this import be used as a periodic import?.
Property 'delimiter' : string
The delimter to seperate the columns in the data.
Property 'countlines' : int
The number of lines in the import.
Property 'countprocessed' : int
The number of lines that are already processed.
Property 'maxmatches' : int
The max amount of matches there will be changed if there are more profiles/subprofiles.
Property 'datetimeformat' : string
The source format of datetime fields in the import file
Property 'notification' : string
Returns a string containing one or more e-mail addresses that

Stay up to date

Receive our monthly top tips, the latest news about database marketing, email marketing, mobile and much more!

Try Copernica yourself!

  • Sign up in less than 30 seconds

  • Access to every feature

  • No upfront payment required

Try Copernica for free