XML-RPC API cust.service.list
Struktura XML-RPC dotazu
<?xml version="1.0"?> <methodCall> <methodName>cust.service.list</methodName> <params> <param><value><string>MD5_customer</string></value></param> <param><value><i4>ID_customer</i4></value></param> </params> </methodCall>
V případě, že hodnota ID_customer je prázdná, vrátí se seznam všech služeb všech zákazníků. Pokud je ID_customer uvedeno, vrátí se pouze seznam služeb uvedeného zákazníka. Nedoporučujeme časté periodické stahování kompletního seznamu služeb, neboť tento seznam může mít i desítky MB a jeho generování může výrazně zatížit server.
Hodnoty odpovědi
%hash =
{
ID_CUSTOMER => $ID_customer,
ID_CUSTOMER_SERVICE => $ID_customer_service,
NAME => $name,
DESCRIPTION => $description,
PRICE => $price,
DPH => $value,
PRICE_DPH => $price_dph,
BARTER => $barter,
ID_BILLING_PERIOD => $ID_billing_period,
ID_AGREEMENT => $ID_agreement,
CREATED => $created,
SIGNED => $signed,
SCHEDULED => $scheduled,
IMPLEMENTED => $implemented,
ACTIVE => $active,
INVOICED => $invoiced,
INVOICE_START => $invoice_start, # zacatek platnosti sluzby
INVOICE_STOP => $invoice_stop, # konec platnosti
AGRREEMENT_NO => $agreement_no,
TYPE_INVOICE => $type_invoice,
TERM_ADDRESS => $term_address,
TERM_ZIP => $term_zip,
TERM_CITY => $term_city,
CUSTOM => %custom_data,
}
%custom_data =
{
CODE => $code,
NAME => $name,
VALUE => $value,
}
Hodnoty odpovědi XML
<?xml version="1.0"?>
<methodResponse>
<params>
<param><value><array>
<data>
<value><struct>
<member><name>TERM_CITY</name><value><string></string></value></member>
<member><name>INVOICE_STOP</name><value><string>0000-00-00</string></value></member>
<member><name>SIGNED</name><value><string>TRUE</string></value></member>
<member><name>TERM_ADDRESS</name><value><string></string></value></member>
<member><name>TYPE_INVOICE</name><value><string>zaloha</string></value></member>
<member><name>PRICE</name><value><double>10000.00</double></value></member>
<member><name>CREATED</name><value><string>TRUE</string></value></member>
<member><name>IMPLEMENTED</name><value><string>TRUE</string></value></member>
<member><name>AGRREEMENT_NO</name><value><string></string></value></member>
<member><name>NAME</name><value><string>AVIDR</string></value></member>
<member><name>DPH</name><value><i4>0</i4></value></member>
<member><name>SCHEDULED</name><value><string>TRUE</string></value></member>
<member><name>TERM_ZIP</name><value><string></string></value></member>
<member><name>ID_BILLING_PERIOD</name><value><i4>4</i4></value></member>
<member><name>INVOICE_START</name><value><string>2008-06-19</string></value></member>
<member><name>PRICE_DPH</name><value><double>10000.0</double></value></member>
<member><name>ACTIVE</name><value><string>TRUE</string></value></member>
<member><name>ID_CUSTOMER</name><value><i4>519</i4></value></member>
<member><name>INVOICED</name><value><string>TRUE</string></value></member>
<member><name>DESCRIPTION</name><value><string>AVID editing station rental (weekly rate)</string></value></member>
<member><name>ID_AGREEMENT</name><value><i4>0</i4></value></member>
<member><name>BARTER</name><value><string>FALSE</string></value></member>
<member><name>ID_CUSTOMER_SERVICE</name><value><i4>1462</i4></value></member>
<member><name>CUSTOM</name>
<value><array><data>
<value><struct>
<member><name>VALUE</name><value><string>pepa</string></value></member>
<member><name>NAME</name><value><string>jmeno</string></value></member>
<member><name>CODE</name><value><string>JME</string></value></member>
</struct></value>
<value><struct>
<member><name>VALUE</name><value><string>novak</string></value></member>
<member><name>NAME</name><value><string>prijmeni</string></value></member>
<member><name>CODE</name><value><string>PRIJ</string></value></member>
</struct></value>
</data></array></value>
</member>
</struct></value>
</data></array></value>
</param>
</params>
</methodResponse>
Příklad v perlu
my $result = $server->call( 'cust.service.list', $md5, 1 );