API/Plans/GetPackagePlans

From Emersion
Revision as of 14:07, 8 June 2016 by JLee (talk) (Created page with "'''Purpose ''' Return high level information for the initial selection of a package by a user. '''Inputs''' <soapenv:Header/> <soapenv:Body> <plan:GetPackagePla...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Purpose

Return high level information for the initial selection of a package by a user.


Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <plan:GetPackagePlansRequest>
        <plan:ServiceTypes>
           <plan:Id></plan:Id>
        </plan:ServiceTypes>
        <plan:Saleable>1</plan:Saleable>
        <plan:SaleableInUserPortal>0</plan:SaleableInUserPortal>
     </plan:GetPackagePlansRequest>
  </soapenv:Body>


Output

  <SOAP-ENV:Body>
     <ns1:GetPackagePlansResponse>
        <ns1:PackagePlan Id="183953">
           <ns1:InternalName>BDS.ADSL.A150001 : BDS - ADSL 1500/256 5GB (AAPT) : Package</ns1:InternalName>
           <ns1:ExternalName>ADSL 1500/256 5GB</ns1:ExternalName>
           <ns1:InternalDescription>2015-09 HUB Migration - Horizon ADSL</ns1:InternalDescription>
           <ns1:Status>Saleable</ns1:Status>
           <ns1:StartDate>2015-08-01</ns1:StartDate>
           <ns1:EndDate xsi:nil="true"/>
           <ns1:SaleableInUserPortal>false</ns1:SaleableInUserPortal>
           <ns1:ServicePlans>
              <ns1:ServicePlan Id="173980">
                 <ns1:InternalName>SP:BDS.ADSL.A150001 : BDS - ADSL 1500/256 5GB (AAPT)</ns1:InternalName>
                 <ns1:ExternalName>ADSL 1500/256 5GB</ns1:ExternalName>
                 <ns1:ServiceType Id="4355">Bendigo Telco - ADSL</ns1:ServiceType>
                 <ns1:AvailableQuantity>1</ns1:AvailableQuantity>
                 <ns1:Mandatory>true</ns1:Mandatory>
              </ns1:ServicePlan>
           </ns1:ServicePlans>
        </ns1:PackagePlan>
   </ns1:GetPackagePlansResponse>
  </SOAP-ENV:Body>


Error String

  • "Invalid or Missing Service Types"
  • "Invalid 'ServiceTypes/ID' value { <ServiceTypeID> } : not an integer"