Standards

Standard Request and Response Fields & Types

📘

The following fields are applicable / available on every request and response.

Request Fields

• Credentials
• Username As String
  • A valid Rev.io login username.
• Password As String
  • Rev.io's password for Username.
• Client As String
  • Client_Code of the Rev.io system you are seeking to access.
• ImpersonationKey As String
  • Optional – used for impersonating another Rev.io user.
• Session
• SessionKey As String
• Debug As Boolean
• Optional – Value of true/false indicating whether to add debug information to the response.

👍

Either Credentials or Session is required on every request. It is more efficient to use Session instead of authenticating with Credentials on every Request, but for simple/low-volume API integrations or for testing purposes, it is convenient to be able to specify Credentials on any request necessary.

Response Fields

• Header
• Success As Boolean
  • Value of true/false indicating if the Request was processed successfully.
• Message As String
  • Typically not returned for successful Requests, but can contain additional information about the Error when applicable.
• Error_Code As String
  • Standardized Error Code as defined in the Error Codes section.
• Error_Description As String
  • Standardized description of the Error Code provided.
• SessionKey As String
  • Returned for any request in which authentication was successful.
• Impersonated As Boolean
  • Indicates the Session is currently impersonating another User through the use of the ImpersonationKey on CredentialAuthentication.
• Debug
• Request
  • Contains the request object as understood by the API. This is only included if the Debug parameter of the request is set or if a fatal processing error occurs.

📘

The following types are used throughout several requests / responses and always share the same fields:

ServiceItem - Encapsulates all information relating to a service

• Service – Individual service object
• ID As Integer – Rev.io service ID.
• Type As String – Type of service
• TN As String – TN of service, or other identification for services without TNs.
• CarrierID As Integer – Rev.io provider id for service.
• CarrierDescription As String – Provider description for provider id.
• PackageID As Integer – Rev.io package id.
• PackageDescription As String – Package description for package id.
• ProgramID As Integer – Rev.io program id.
• ProgramDescription As String – Program description for program id.
• Products – List of products that belong to this service
  • Product – Individual product.
    • ID As Integer – Rev.io customer product id.
    • ProductID As Integer – Rev.io product id.
    • CarrierID As Integer – Rev.io provider id.
    • CarrierDescription As String – Provider description for provider id.
    • Status As Enum_Customer_Product_Status – Current customer product status. Can be one of the following values:
      • PENDING – Product has not yet activated and is pending activation.
      • ACTIVE – Product is active and billing.
      • DENIED – Product was active, but has been suspended.
      • DISCONNECTED – Product has been completely disconnected and is no longer billing.
    • Description As String – Description of product.
    • Rate As Decimal – Rate being charged to customer monthly for the product. Credits are indicated by a negative amount in this field.
    • Code1 As String – Product code 1. Used for provisioning.
    • Code2 As String – Product code 2. Used for provisioning.
    • ActivatedDate As Date – Date product first became active.
    • BilledThroughDate As Date – Date to which customer has been billed for this product.
    • Quantity As Integer – Quantity of products purchased by customer
• Inventory – List of inventory items that belong to this service
  • Inventory – Individual inventory object.
    • ID As Integer – Rev.io inventory item id.
    • CustomerID As Integer – Rev.io customer id that this inventory item is associated with.
    • Identifier As String – Inventory identifier.
    • IdentifierLabel As String – The identifier label of this item, such as ESN, MEID, etc.
    • InventoryTypeID As Integer – Rev.io inventory type id.
    • InventoryType As Enum_Inventory_Type – Rev.io inventory type. Can be one of the following:
      • General – General inventory type for inventory not covered by another type.
      • Telephone_Number – Telephone number.
      • IP_Address – An IP address.
      • Mobile_Device – A wireless mobile device.
      • SIM_Card – A wireless SIM card.
    • InventoryDescription As String – Description from inventory type id.
    • Status As Enum_Inventory_Item_Status – Current status of inventory item. Can be one of the following:
      • AVAILABLE – Inventory is not activated and is available to be associated with a customer or activated on a batch.
      • UNAVAILABLE – Inventory is not activated and may not be used.
      • ASSIGNED – Inventory is assigned to a customer.
      • BATCHED – Inventory is on a batch.
    • AssignedDate As Date – Date the inventory was assigned to this customer.
    • UnavailableReasonID As Integer – When status is UNAVAILABLE, the reason id of why inventory is unavailable (if applicable).
    • UnavailableReasonDescription As String – The description of the unavailable reason id (if applicable).
    • Note As String – Inventory note.
    • Fields – List of custom fields.
      • Field – Individual custom field
        • FieldID As Integer – Rev.io custom field id.
        • Label As String – Rev.io custom field label.
        • Value As String – Value specified for custom field.
    • Wireless – Object containing wireless-specific inventory fields
      • MSID As String – MSID of inventory item.
      • MSL As String – MSL of inventory item.
      • MDN As String – Current MDN of inventory item.
• Fields - List of customer-level custom fields.
  • Field - Individual Custom Field
    • FieldID As Integer – Custom Field ID.
    • Label As String – Custom Field Label.
    • Value As String – Value of Custom Field.

Enumerated Values

This listing explains in more detail what the standard members mean for the enumerated types used by the API.

Enum_Order_Status

Enum_Order_Type

Enum_Lifeline_Status

Enum_Pin_Status

Enum_Ticket_Status

Enum_TPIV_Status

CCHTaxExemption (used only by instances that do not use SureTax for taxation)

SureTaxTaxExemptionEnum (used only by instances that use SureTax for taxation)

Error Codes

When an error code is returned by the API, this table explains the code in detail.

Error Code Listing