3.2 getCustomerList

Vypíše seznam zákazníků podle nastaveného vstupního filtru. Původně funkce VoipexZakazniciList.

VSTUP:

• filter
  • int id (nepovinný) – id zákazníka
  • string company (nepovinný) – název firmy
  • string street (nepovinný) - ulice
  • string city (nepovinný) - město
  • string zipCode (nepovinný) - PSČ
  • string customer (nepovinný) – jméno zákazníka
  • string note (nepovinný) - poznámka
  • string login (nepovinný) – přihlašovací jméno zákazníka
  • string password (nepovinný) - přihlašovací heslo zákazníka
  • string tin (nepovinný) - IČO
  • string externId (nepovinný) - id z externího systému
• string fulltext - hledaní fulltextem v názvu, adrese a poznámce zákazníka
• string number – hledání podle císla
• int detail - 0=základní informace / 1=rozšířené informace, tento parametr není implementován

VÝSTUP:

• customers[] – pole ústředen
  • int id – id zákazníka
  • string company – název firmy
  • string street (nepovinný) - ulice
  • string city (nepovinný) - město
  • string zipCode (nepovinný) - PSČ
  • string contact (nepovinný) – kontakt na zákazníka
  • string note (nepovinný) - poznámka
  • int numberCount (nepovinný) – počet čísel
  • string paymentType (nepovinný) – typ režimu placení, parametr se nevyužívá
  • string tin (nepovinný) - IČO
  • string externId (nepovinný) - id z externího systému
• int result - kód chyby
• string resultText - textový popis chyby

CHYBY:

• 0 - OK
• 1 – Chyba vstupních parametrů. Popis chyby je v resultText.

PŘÍKLAD XML ŽÁDOSTI

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prov="http://www.ipex/ProviderManagement.xsd1" xmlns:urn="urn:apiipex:providermanagement">
  <soapenv:Header>
    <prov:verifyAccess>
      <accessToken></accessToken>
    </prov:verifyAccess>
  </soapenv:Header>
  <soapenv:Body>
    <urn:getCustomerList>
      <filter>
        <!--Optional:-->
        <id></id>
        <!--Optional:-->
        <company></company>
        <!--Optional:-->
        <street></street>
        <!--Optional:-->
        <city></city>
        <!--Optional:-->
        <zipCode></zipCode>
        <!--Optional:-->
        <customer></customer>
        <!--Optional:-->
        <note></note>
        <!--Optional:-->
        <login></login>
        <!--Optional:-->
        <password></password>
        <!--Optional:-->
        <tin></tin>
        <!--Optional:-->
        <externId></externId>
      </filter>
      <fulltext></fulltext>
      <number></number>
      <detail></detail>
    </urn:getCustomerList>
  </soapenv:Body>
</soapenv:Envelope>

PŘÍKLAD XML ODPOVĚDI

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:api-ipex:providermanagement">
  <SOAP-ENV:Body>
    <ns1:getCustomerListResponse>
      <customers>
        <item>
          <id></id>
          <company></company>
          <street></street>
          <city></city>
         <zipCode></zipCode>
         <contact></contact>
         <note></note>
         <login></login>
         <password></password>
         <numberCount></numberCount>
         <tin></tin>
         <externId></externId>
       </item>
     </customers>
     <result>0</result>
     <resultText/>
   </ns1:getCustomerListResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>