Processing transmitted parameters
July 11, 2024
ID 206493
When calling a method, all input parameters must be indicated. An empty value of xsi:nil="true" can be transmitted for some parameters. An example is provided below:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cli="ClientNS2"
xmlns:cli1="ClientTypes" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<cli:get_protocol_ratio>
<cli:Auth>
<cli1:client_id>205</cli1:client_id>
<cli1:user_id>71</cli1:user_id>
<cli1:hash>d9a3d9fd3a31202b2cc6910c9871dbe9</cli1:hash>
</cli:Auth>
<cli:client_id>205</cli:client_id>
<cli:locale_id>77</cli:locale_id>
<cli:resource_id>1017</cli:resource_id>
<cli:start>2016-01-01 00:00:00</cli:start>
<cli:end xsi:nil="true"/>
</cli:get_protocol_ratio>
</soapenv:Body>
</soapenv:Envelope>
In this case, "None" is written to concatenate the empty value of the parameter:
20571get_protocol_ratio2057710172016-01-01 00:00:00NoneSecretKey1489450800
Resulting hash in lowercase:
d9a3d9fd3a31202b2cc6910c9871dbe9
Methods may return empty values with the xsi:nil="true" flag.
The capability to transmit a specific parameter with an empty value is indicated in the documentation.
In methods that display information, specifying a parameter in xsi:nil="true" means that the specific parameter is not taken into account when generating a response.
In methods that work with a date, "timestamp +00:00" is used in input and output parameters: YYYY-MM-DD hh:mm:ss.