API/Orders/SelectPackagePlan

From Emersion
Jump to: navigation, search

SelectPackagePlan

Purpose: The system needs to know what package is selected by the customer in an order. This can only be done once per order. The order will error if subsequent submissions via this call are received.

WDSL : Orders.wsdl

Inputs

  • ResetAnyExistingServiceConfiguration is optional and default value is false ( Retain service configuration )
     <ord:SelectPackagePlanRequest>
        <ord:AccountPresaleID>100363</ord:AccountPresaleID>
        <ord:PackagePlanID>184020</ord:PackagePlanID>
        <ord:ResetAnyExistingServiceConfiguration>false</ord:ResetAnyExistingServiceConfiguration>
     </ord:SelectPackagePlanRequest>

Outputs

     <ns1:SelectPackagePlanResponse>
        <ns1:PackagePlan>
           <ns1:ID>184020</ns1:ID>
           <ns1:InternalName>BDS.1303.X163.TEL.12M : BDS - Premium Internet - X.163 (TELSTRA) - 12 Month Contract : X.163 - 2M/2M 500GB Monthly Fee : Package</ns1:InternalName>
           <ns1:ExternalName>X163 - 2M 500GB</ns1:ExternalName>
           <ns1:ServiceAllowances>
              <ns1:ServiceAllowance>
                 <ns1:ServicePlanID>174047</ns1:ServicePlanID>
                 <ns1:ServiceTypeID>4362</ns1:ServiceTypeID>
                 <ns1:Quantity>1</ns1:Quantity>
                 <ns1:Mandatory>1</ns1:Mandatory>
                 <ns1:ServicePlanProperty>
                    <ns1:ID>306</ns1:ID>
                    <ns1:Name>KB_MB_PRESENTATION</ns1:Name>
                    <ns1:Label>Kilobyte to Megabyte Presentation</ns1:Label>
                    <ns1:Value/>
                 </ns1:ServicePlanProperty>
              </ns1:ServiceAllowance>
           </ns1:ServiceAllowances>
        </ns1:PackagePlan>
     </ns1:SelectPackagePlanResponse>

Error String

SP Account Validation

  • "Undefined account status" : Account status is not defined
  • "Undefined account type" : Account type is not defined
  • "Account Type is not eligible to create order" : Account type is wholesale account
  • "Order creation is restricted for this account" : Account Status can not order is set to 1 or account type can not order is set to 1
  • "This account is 'Account Status Name' - please contact your upstream provider" : Account status is suspended or restricted

End User Account Validation

  • "Missing account presale id" : Account presale id is not supplied or less than 1
  • "Invalid account presale id" : Account presale id length less than 6 digits
  • "Account presale is not valid for order" : Account presale has been completed
  • "Account presale already contain package plan" : Account presale has package plan
  • "'Missing package plan id'" : Package plan id does not exist or less than 0
  • "Invalid package plan id" : Package plan id less than 6 digits
  • "Undefined package plan" : Package plan does not exist or package plan belong to other provider.