Back to API references

SOAP API method WebForm_database

Description

Returns the database bound to this webform.

Parameters

Name Type Description
id * int Unique identifier (id) of the object WebForm. The method only applies to the webform 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
database Structure of type 'database'

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 'database'

Name Type Description
id int The ID of the database.
name string The name of the database.
description string The description of the database.
archived boolean The database is archived.
created timestamp The date and time when the account was created.
unsubscribebehavior string Get the unsubscribe behavior of the database. Possible values are 'nothing', 'remove' or 'update'.
countprofiles int The number of profiles.
lastbuilt timestamp When was the profile rebuilt for the last time?