Back to API references

SOAP API method Profile_directory

Description

Method returns a single directory of the profile. The return value is a ProfileDir object is the directory exists, or false if it does not.

Parameters

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

Return values

Name Type Description
profiledir Structure of type 'profiledir'

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

Name Type Description
id int The ID of the directory.
name string The name of the directory.