7.5 getTariffPlanList

Vypíše seznam ceníků. Původně funkce VoipexVypisCeniku.

 

VSTUP:

  • filter - dostupné od verze v2
    • int id - vypíše pouze ceník s konkrétním ID
    • enum type - filtrování dle typu využití ceníku (endUser, mobile, voip, all)

VÝSTUP:

  • tariffPlan[] – pole ceníku
    • string name – název ceníku
    • int id – id ceníku
    • int versionId – verze ceníku
    • date validFrom – platný od
    • date validUntil – platný do
    • string flags (nepovinný) - příznaky
    • int administrator (nepovinný) – správce
    • availableUnitsName (nepovinný) - pojmenování volných jednotek význam
      • string slot1 – název volných jednotek 1
      • string slot2 – název volných jednotek 2
      • string slot3 – název volných jednotek 3
      • string slot4 – název volných jednotek 4
    • costTariffPlan – nákladový ceník
      • string name – název ceníku
      • int id – id ceníku
      • int versionId – verze ceníku
      • date validFrom – platný od
      • date validUntil – platný do
      • string flags (nepovinný) - příznaky
      • int administrator (nepovinný) – správce
      • availableUnitsName (nepovinný) - pojmenování volných jednotek
        • string slot1 – název volných jednotek 1
        • string slot2 – název volných jednotek 2
        • string slot3 – název volných jednotek 3
        • string slot4 – název volných jednotek 4
  • int result - kód chyby
  • string resultText - textový popis chyby

 

CHYBY:

  • 0 - OK
  • >0 - chyba vstupních parametrů
  • <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:getTariffPlanList/>
  </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:getTariffPlanListResponse>
      <tariffPlan>
        <item>
          <name></name>
          <id></id>
          <versionId></versionId>
          <validFrom></validFrom>
          <validUntil></validUntil>
          <flags></flags>
          <availableUnitsName>
            <slot1></slot1>
            <slot2></slot2>
            <slot3></slot3>
            <slot4></slot4>
          </availableUnitsName>
          <costTariffPlan>
            <name></name>
            <id></id>
            <versionId></versionId>
            <validFrom></validFrom>
            <validUntil></validUntil>
            <flags></flags>
            <availableUnitsName>
              <slot1></slot1>
              <slot2></slot2>
              <slot3></slot3>
              <slot4></slot4>
            </availableUnitsName>
          </costTariffPlan>
        </item>
      </tariffPlan>
      <result></result>
      <resultText/>
    </ns1:getTariffPlanListResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>