Planfix API contact.updateContractors: Difference between revisions
From Planfix
(Created page with "This function changes the information about a contact's affiliation with the company. Request format: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="contact.updateContractors"> <account></account> <sid></sid> <contact> <id></id> <contractors> <addClient> <id></id> <id></id> <!-- --> </addClient> <delClient> <id></id> <id></id> <!-- --> </delClient> </co...") |
(→Go To) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 53: | Line 53: | ||
</source> | </source> | ||
{| class="wikitable" style="margin-top: 1em; width:100% " | {| class="wikitable" style="margin-top: 1em; width:100% " | ||
!width="150"| | !width="150"|Name !!width="200"| Type !!width="50%"| Value !! Note | ||
|- | |- | ||
|contact.id ||int || contact identifier|| | |contact.id ||int || contact identifier|| | ||
Line 67: | Line 67: | ||
</response> | </response> | ||
</source> | </source> | ||
== Go To == | == Go To == | ||
*[[Planfix API:Contacts]] | *[[Planfix API:Contacts]] | ||
*[[Error codes]] | *[[Error codes XML API v1|Error codes]] | ||
*[[List of functions]] | *[[List of functions]] |
Latest revision as of 09:24, 6 March 2024
This function changes the information about a contact's affiliation with the company. Request format:
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.updateContractors">
<account></account>
<sid></sid>
<contact>
<id></id>
<contractors>
<addClient>
<id></id>
<id></id>
<!-- -->
</addClient>
<delClient>
<id></id>
<id></id>
<!-- -->
</delClient>
</contractors>
</contact>
<signature></signature>
</request>
Name | Тип | Value | Note |
---|---|---|---|
id | |||
contractors | root element of companies | ||
contractors.addClient | list of companies the contact is affiliated with | ||
contractors.addClient.id | id | company identifier | |
contractors.delClient | list of companies to be removed from the contact's list of companies | ||
contractors.delClient.id | id | company identifier | |
signature |
Result of successful execution:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<contact>
<id></id>
</contact>
</response>
Name | Type | Value | Note |
---|---|---|---|
contact.id | int | contact identifier |
Otherwise, an error response will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>