9.2 getRequestList

Vypíše přehled objednávek pro zákazníka, tel. číslo, celého providera nebo operátora podle stavu nebo data.

 

VSTUP:

  • filter – vstupní filtr
    • int requestId (nepovinný) – id objednávky
    • string requestStatus enum { popis hodnot } (nepovinný) – stav objednávky
    • string requestType enum { popis hodnot } (nepovinný) – typ objednávky
    • string login (nepovinný) - přihlašovací jméno uživatele, který vytvořil objednávku
    • int customerId (nepovinný) – id zákazníka
    • string identifier (nepovinný) - obecná identifikace objednávky např. tel. číslo
    • string identifier2 (nepovinný) - obecná identifikace2 objednávky např. iccid
    • dateTime insertedFrom (nepovinný) – vytvořeno od
    • dateTime insertedTo (nepovinný) - vytvořeno do
    • dateTime changedFrom (nepovinný) – poslední změna od
    • dateTime changedTo (nepovinný) - poslední změna da
    • boolean detail (nepovinný) – podrobnější výpis

 

VÝSTUP:

  • requests[] – pole požadavku
    • int requestId – id objednávky
    • string requestType enum { popis hodnot } – typ objednávky
    • int customerId – id zákazníka
    • string customerName – jméno zákazníka
    • string login – přihlašovací jméno uživatele, který vytvořil objednávku
    • dateTime inserted – datum vytvoření
    • dateTime changed – poslední datum změny
    • string status enum { 'new', 'processing', 'canceled', 'finished', 'error' } – stav objednávky
    • string identifier - obecná identifikace objednávky
    • string identifier2 - obecná identifikace2 objednávky
    • string resultNote - poznámka ke stavu objednávky
  • 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:getRequestList>
      <filter>
        <!--Optional:-->
        <requestId></requestId>
        <!--Optional:-->
        <requestStatus></requestStatus>
        <!--Optional:-->
        <login></login>
        <!--Optional:-->
        <customerId></customerId>
        <!--Optional:-->
        <identifier></identifier>
        <!--Optional:-->
        <identifier2></identifier2>
        <!--Optional:-->
        <insertedFrom></insertedFrom>
        <!--Optional:-->
        <insertedTo></insertedTo>
        <!--Optional:-->
        <changedFrom></changedFrom>
        <!--Optional:-->
        <changedTo></changedTo>
        <!--Optional:-->
        <detail></detail>
      </filter>
    </urn:getRequestList>
  </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:getRequestListResponse>
      <requests>
        <request>
          <requestId></requestId>
          <requestType></requestType>
          <customerId></customerId>
          <customerName></customerName>
          <login></login>
          <inserted></inserted>
          <changed></changed>
          <status></status>
          <identifier></identifier>
          <identifier2></identifier2>
          <resultNote></resultNote>
        </request>
      </requests>
      <result>0</result>
      <resultText/>
    </ns1:getRequestListResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>