Back to API references

SOAP API method FaxMailingDestination_subProfile

Description

If the destination is a subprofile, it will return the subprofile, otherwise it will return false.

Parameters

Name Type Description
id * string Unique identifier (id) of the object FaxMailingDestination. The method only applies to the faxmailingdestination 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
subprofile Structure of type 'subprofile'

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

Name Type Description
id int The ID of the subprofile.
code string The code of the subprofile.
created timestamp The timestamp when the subprofile was created.
modified timestamp The timestamp when the subprofile was last modified.
lastexport timestamp The last timestamp when the subprofile was exported.
fields Map Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true