Standards

Standard Request and Response Fields & Types

📘

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

Request Fields

• Credentials
• UsernameAs String
  • A valid Rev.io login username.
• PasswordAs String
  • Rev.io's password for Username.
• ClientAs String
  • Client_Code of the Rev.io system you are seeking to access.
• ImpersonationKeyAs String
  • Optional – used for impersonating another Rev.io user.
• Session
• SessionKeyAs String
• DebugAs 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
• SuccessAs Boolean
  • Value of true/false indicating if the Request was processed successfully.
• MessageAs String
  • Typically not returned for successful Requests, but can contain additional information about the Error when applicable.
• Error_CodeAs String
  • Standardized Error Code as defined in the Error Codes section.
• Error_DescriptionAs String
  • Standardized description of the Error Code provided.
• SessionKeyAs String
  • Returned for any request in which authentication was successful.
• ImpersonatedAs 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
• IDAs Integer – Rev.io service ID.
• TypeAs String – Type of service
• TNAs String – TN of service, or other identification for services without TNs.
• CarrierIDAs Integer – Rev.io provider id for service.
• CarrierDescriptionAs String – Provider description for provider id.
• PackageIDAs Integer – Rev.io package id.
• PackageDescriptionAs String – Package description for package id.
• ProgramIDAs Integer – Rev.io program id.
• ProgramDescriptionAs String – Program description for program id.
• Products – List of products that belong to this service
  • Product – Individual product.
    • IDAs Integer – Rev.io customer product id.
    • ProductIDAs Integer – Rev.io product id.
    • CarrierIDAs Integer – Rev.io provider id.
    • CarrierDescriptionAs String – Provider description for provider id.
    • StatusAs 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.
    • DescriptionAs String – Description of product.
    • RateAs Decimal – Rate being charged to customer monthly for the product. Credits are indicated by a negative amount in this field.
    • Code1As String – Product code 1. Used for provisioning.
    • Code2As String – Product code 2. Used for provisioning.
    • ActivatedDateAs Date – Date product first became active.
    • BilledThroughDateAs Date – Date to which customer has been billed for this product.
    • QuantityAs Integer – Quantity of products purchased by customer
• Inventory – List of inventory items that belong to this service
  • Inventory – Individual inventory object.
    • IDAs Integer – Rev.io inventory item id.
    • CustomerIDAs Integer – Rev.io customer id that this inventory item is associated with.
    • IdentifierAs String – Inventory identifier.
    • IdentifierLabelAs String – The identifier label of this item, such as ESN, MEID, etc.
    • InventoryTypeIDAs Integer – Rev.io inventory type id.
    • InventoryTypeAs 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.
    • InventoryDescriptionAs String – Description from inventory type id.
    • StatusAs 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.
    • AssignedDateAs Date – Date the inventory was assigned to this customer.
    • UnavailableReasonIDAs Integer – When status is UNAVAILABLE, the reason id of why inventory is unavailable (if applicable).
    • UnavailableReasonDescriptionAs String – The description of the unavailable reason id (if applicable).
    • NoteAs String – Inventory note.
    • Fields – List of custom fields.
      • Field – Individual custom field
        • FieldIDAs Integer – Rev.io custom field id.
        • LabelAs String – Rev.io custom field label.
        • ValueAs String – Value specified for custom field.
    • Wireless – Object containing wireless-specific inventory fields
      • MSIDAs String – MSID of inventory item.
      • MSLAs String – MSL of inventory item.
      • MDNAs String – Current MDN of inventory item.
• Fields - List of customer-level custom fields.
  • Field - Individual Custom Field
    • FieldIDAs Integer – Custom Field ID.
    • LabelAs String – Custom Field Label.
    • ValueAs 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