Packages

Packages_Query

Used to search for one or more Packages (e.g. 100 Minutes Monthly for $19.99) from Settings > Packages.

Required Input

None

Optional/Conditional Input

• PackageID As Integer – when specified, will only return an item matching this.
• State As String – when specified, will only return items valid in this state
• CarrierID As Integer – when specified, will only return items for this provider. Cannot be used with CarrierCode.
• CarrierCode As String – when specified, will only return items for this provider. Cannot be used with CarrierID.
• CustomerClass As String – when specified, will only return items that are Business or Residential. By default it returns all.
• Zip As String – when specified, must be 5 digits. Must be valid zip code.
• BillProfileID As Integer – when specified, will only return items assigned to this Bill Profile.
• AvailabilityLocation As String – when specified, will only return items available based on this setting. Valid values:
  • Available_On_Agent_Portal_Flag
  • Available_On_Signup_Flag
• PackageCategoryID As Integer – when specified, will only return item with the specified Package Category.
• PackageCategory As String – when specified, will only return item with the specified Package Category by String (can be used instead of PackageCategoryID).
• Inventory – when specified, will only return items applicable for the specified inventory item.
  • Identifier As String – The inventory identifier (ESN, MEID, ICCID, etc.). Required when Inventory object is not null.
  • Type As String – The type of inventory. Required when Inventory object is not null. Valid values are:
    • Mobile_Device – A wireless mobile device (handset).
    • SIM_Card – A SIM card or RUIM.
    • IP_Address – An IP address.
    • Telephone_Number – A telephone number.
    • General – Other inventory not of a specific type.
• ServiceTypeID As Integer – when specified, will return items assigned to this Service Type or that do not have Service Type association.

Output

• A list of matching:
  • ID As Integer – Package_ID field from Rev.io's Package (Settings > Packages)
  • Name As String – Description field from Rev.io's Package (Settings > Packages)
  • DescriptionAs String – Description On Bill field from Rev.io's Package (Settings > Packages)
  • Details As String – Long Description field from Rev.io's Package (Settings > Packages)
  • RateMonthly As String – Pre-tax recurring charge for this Package.
  • RateOneTime As Decimal – Pre-tax non-recurring charge for this Package.
  • IsLifelineOnly As Boolean – True if this Package is only available for Lifeline customers.
  • IsTribalOnly As Boolean – True if this Package is only available for Tribal Lifeline customers.
  • PackageCategoryID As Integer – Returns a PackageCategoryID of a package
  • PackageCategory As String – Returns the string value of the PackageCategory