Toggle navigation
Client Portfolio API
Documentation
Login
EN
LV
RU
EN
login
logout
get_lists
get_objects
get_object
add_list
update_list
delete_list
add_object
update_object
delete_object
get_available_services
add_list_monitoring
update_list_monitoring
get_list_monitoring
get_monitoring_sessions
get_session_events
Function documentation: add_list_monitoring
×
These are samples of function request and answer with predefined values. In order to fulfill a request with real values, please, get the authorization tools
here
.
Function creates monitoring for the chosen Client Portfolio list.
Field name
Value
Description
Type
signature
SSL signature in base64 encoding
string
sid
Session key
string
list_id
List identifier
int
email
E-mail addresses where to send monitoring e-mails (separate by commas)
stringArray
empty_mail
FALSE
Indicator if to send an email in case no event was selected in the monitoring session
boolean
period
Monitoring period. Possible values: D - day, W - week, M - month
string
start_date
Monitoring activity period start date in ISO 8601 format (YYYY-MM-DD)
string
services
Codificators of chosen monitoring services
stringArray
end_date
Monitoring activity period enddate in ISO 8601 format (YYYY-MM-DD)
string
Confirm
Request
Answer
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:ApiControllerwsdl" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <ns1:add_list_monitoring> <signature xsi:type="xsd:string">UNCgcq2HkN/ZFU04INkBBGFHJcC2L/nSZ8eNPh/YOagi4WRiWv2OOIdX1Nk72tlRdspkb/yzi/DhJ0x4veGO3j0+xOGJQVsjCfr0AR6tyeAP6kv3BhsxIKtGttqFalYNpuScP6DtnIJXB+ebZpbkGYnsoAqqqrLEjQl6aWN1fuDZWIuvAgjmzy6GLFRyPl4iKncSV4q/6qBTKSPPqFKxf5UF6aj+m1tvWIC2KhsxODOjfq94GK70+Zaf6jqH1ZqromATiXcqZYxK/NXluHhTJh40C0j5S3+dxH6GErb8C7pHpnxDGnTvaf2zpPhvChlQDkbrlOZt+JUAc+eK0ygKTA==</signature> <sid xsi:type="xsd:string">b38db9621d20a843bfc43d45d39e340b</sid> <list_id xsi:type="xsd:int">6751</list_id> <email SOAP-ENC:arrayType="ns1:string[1]" xsi:type="ns1:stringArray"> <item xsi:type="xsd:string">info@lursoft.lv</item> </email> <empty_mail xsi:type="xsd:boolean">false</empty_mail> <period xsi:type="xsd:string">D</period> <start_date xsi:type="xsd:string">2015-02-23</start_date> <services SOAP-ENC:arrayType="ns1:string[1]" xsi:type="ns1:stringArray"> <item xsi:type="xsd:string">CH_NOS</item> </services> <end_date xsi:type="xsd:string">2015-02-28</end_date> </ns1:add_list_monitoring> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:ApiControllerwsdl" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <ns1:add_list_monitoringResponse> <return xsi:type="ns1:MonitoringResponse"> <monitoring xsi:type="ns1:ResponseMonitoring"> <monitoring_id xsi:type="xsd:int">5294</monitoring_id> <list_id xsi:type="xsd:int">6751</list_id> <email xsi:type="xsd:string">info@lursoft.lv</email> <period xsi:type="xsd:string">D</period> <start_date xsi:type="xsd:string">2015-02-23</start_date> <end_date xsi:type="xsd:string">2015-02-28</end_date> <empty_email xsi:type="xsd:boolean">false</empty_email> <object_count xsi:type="xsd:int">1</object_count> <services SOAP-ENC:arrayType="ns1:ResponseService[1]" xsi:type="ns1:ResponseServiceArray"> <item xsi:type="ns1:ResponseService"> <type xsi:type="xsd:string">CH_NOS</type> <name xsi:type="xsd:string">Izmaiņas uzņēmuma nosaukumā</name> </item> </services> </monitoring> <success xsi:type="xsd:boolean">true</success> <message xsi:type="xsd:string">OK</message> </return> </ns1:add_list_monitoringResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>