6.1 getContainerList

Zobrazí výpis ústředen, s položkami jako název TS, typ, počet aktivních čísel atd. Původně funkce VoipexUstrednyList.

 

VSTUP:

  • string type enum { 'Mobile', 'ISP', 'Other', 'Any' } – typ ústředny, podporováno od verze v2

 

VÝSTUP:

  • containers[] – pole ústředen
    • int id – id ústředny
    • string host – umístění ústředny
    • string vendor (nepovinný) - výrobce
    • string vendorType (nepovinný) – typ výrobce
    • string management (nepovinný) - správce
    • string type (nepovinný) – typ provedení (virtuální, fyzická)
    • string activeNumbers (nepovinný) - počet aktivních čísel
  • int result - kód chyby
  • string resultText - textový popis chyby

 

CHYBY:

  • 0 - OK
  • >0 - Chyba vstupních parametru. Popis chyby je v resultText.
  • <0 - interní chyba

 

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:getContainerList>
      <type></type>
    </urn:getContainerList>
  </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:getContainerListResponse>
      <containers>
        <item>
          <id></id>
          <host></host>
          <vendor></vendor>
          <vendorType></vendorType>
          <management></management>
          <type></type>
          <activeNumbers></activeNumbers>
        </item>
      </containers>
      <result>0</result>
      <resultText/>
    </ns1:getContainerListResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>