List all properties

GET /api/client-property-values
<?xml version="1.0" encoding="UTF-8"?>
<client-property-values type="array" page="1" per_page="100" total="2">
    <client-property-value>
        ...
    </client-property-value>
    <client-property-value>
        ...
    </client-property-value>
</client-property-values>

The list can be filtered with parameters:

GET /api/client-property-values?client_id=123

The following parameters can be used:

Parameter Description
client_id ID of a client
client_property_id ID of an attribute
value Value of an attribute

Get a single property

GET /api/client-property-values/{id}
<?xml version="1.0" encoding="UTF-8"?>
<client-property-value>
    <id type="integer">1</id>
    <client_id type="integer">2</client_id>
    <client_property_id type="integer">3</client_property_id>
    <type>TEXTFIELD</type>
    <name>Department</name>
    <value>Marketing</value>
</client-property-value>

The type of the attribute can be: TEXTFIELD = single line textfield, TEXTAREA = multi line text field, CHECKBOX = Checkbox

Set client property

POST /api/client-property-values
XML element Description Type Default value Mandatory
client_id ID of the client INT yes
client_property_id ID of the property INT yes
value Property value ALNUM yes 
<client-property-value>
    <client_id>2</client_id>
    <client_property_id>3</client_property_id>
    <value>Sales department</value>
</client-property-value>

<?xml version="1.0" encoding="UTF-8"?>
<client-property-value>
    <id type="integer">1</id>
    <client_id type="integer">2</client_id>
    <client_property_id type="integer">3</client_property_id>
    <type>TEXTFIELD</type>
    <name>department</name>
    <value>Sales department</value>
</client-property-value>