SOAP API method ProfileDir_directory

Back to API references

Description
A single directory. The supplied parameter can be either a name, an ID or a directory object. The return value is a PxPomProfileDir object is the subdirectory exists, or false if it does not

Parameters
Parameter 'id' : int
Unique identifier (id) of the object ProfileDir. The method only applies to the profiledir with this id.
Parameter 'name' : string
Parameter 'login' : Structure of type 'login'
Optional login data

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

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 'profiledir'
This structure profiledir was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the directory.
Property 'name' : string
The name of the directory.