SOAP API method Profile_createSubProfile
Description
Creates and returns a subprofile, based on a collection name or ID and a assoc array of fields witch should be filled in the subprofile.
Parameters
- Parameter 'id' : int
- Unique identifier (id) of the object Profile. The method only applies to the profile with this id.
- Parameter 'timestamp' : string
- The timestamp for the historic profile
- Parameter 'collection' : Structure of type 'collection'
- Parameter 'fields' : Collection of type 'fields'
- Is the same as an assoc array
- Parameter 'caller' : Structure of type 'caller'
- The caller object (or null if called by old code)
- Parameter 'login' : Structure of type 'login'
- Optional login data
Return values
- Return value 'subprofile' : Structure of type 'subprofile'
Structure 'collection'
This structure collection was mentioned above. This structure has the following properties:
- Property 'id' : int
- The ID of the collection.
- Property 'name' : string
- The name of the collection.
- Property 'weight' : int
- The weight of the collection.
- Property 'created' : string
- The date and time when the account was created.
- Property 'unsubscribebehavior' : string
- Get the unsubscribe behavior of the collection. Possible values are 'nothing', 'remove' or 'update'.
- Property 'countsubprofiles' : int
- The number of subprofiles.
- Property 'lastbuilt' : timestamp
- When was the item rebuilt for the last time?
Structure 'pair'
This structure pair was mentioned above. This structure has the following properties:
- Property 'key' : string
- Property 'value' : string
Structure 'fields'
This structure fields was mentioned above. This structure has the following properties:
- Property 'pair' : Structure of type 'pair'
Structure 'caller'
This structure caller was mentioned above. This structure has the following properties:
- Property 'followups' : bool
- Are the follow-ups enabled
- Property 'caller' : string
- The name of the caller
- Property 'identity' : string|null
- The identity of the caller, this is the name that is accepted by the webcaller
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 'subprofile'
This structure subprofile was mentioned above. This structure has the following properties:
- Property 'id' : int
- The ID of the subprofile.
- Property 'code' : string
- The code of the subprofile.
- Property 'created' : timestamp
- The timestamp when the subprofile was created.
- Property 'modified' : timestamp
- The timestamp when the subprofile was last modified.
- Property 'lastexport' : timestamp
- The last timestamp when the subprofile was exported.
- Property 'fields' : Map
- Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true