Back to API references

SOAP API method Collection_checkConstraints

Description

Check if the constraints allows the subprofile into the collection with the supplied fields.

Parameters

Name Type Description
id * int Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
fields * Collection of type 'fields' The fields to be inserted or updated.
profile Structure of type 'profile' The subprofile that will be updated.
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
value boolean

Structure 'pair'

Name Type Description
key string
value string

Structure 'fields'

Name Type Description
pair Structure of type 'pair'

Structure 'profile'

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

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