Matching results

Offer & Options

An offer represents the entity used to bill the airtime consumption of the systems.
An offer can have some options which can be added or removed on systems.

Read only fields are computed by AirVantage and can only be seen on response fragments sent by find request.

Offer

Field Description Read Only Type
uid Offer's unique identifier. true uid
name Offer's name. true string
limit The maximum number of bytes authorized for this offer. true number
types Possible values are: LITE, LITE2, ADVANCED, ADVANCED2, TAILORED, BROADBAND, PASSIVE, BOOTSTRAP true string
connection.uid Uid of the Operator connection for which the offer is restricted. true string
connection.name Name of the Operator connection for which the offer is restricted. true string
bundle True if the offer is a bundle offer otherwise false true boolean
connectivity True if the offer is a connectivity offer otherwise false true boolean

Options

Field Description Read Only Type
uid Option's unique identifier. true uid
name Name of the option. true string
type Type of the option. Types are GENERAL, SERVICE, ROAMING true string

This is a complete representation of an Offer.

{
       "uid": "Offer uid",
       "name": "Offer name",
       "limit": 10485760,
       "types":["LITE", "LITE2"]
}

This is a complete representation of an Option.

{
       "uid": "Option uid",
       "name": "Option name",
       "type": "SERVICE"
}

/api/v1/offers

Returns a list of available offers

Request

GET https://na.airvantage.net/api/v1/offers

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
[
    {
        "uid": "5b909116ee1749559c6941766168dae5",
        "name": "My Offer",
        "limit": 10485760,
        "types": [ "LITE" ],
        "bundle": false,
        "connectivity": true,
        "connection": {
            "uid": "1634025233174ad0b93e7d5380fb3b03",
            "name": "Sierra Wireless"
        }
    }
]
Name Description Use Default Type Operand
company Set the context company. optional caller's company uid =
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions None

/api/v1/offers/{uid}/options

Returns the options of the specified offer

Request

GET https://na.airvantage.net/api/v1/offers/257f1e80d39f457f95c67549e3d65688/options

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
[
  {
    "type": "ROAMING",
    "uid": "43c9ea75020f4fa2b24ff4c9b8f4884c",
    "name": "AFRICA - Central"
  },
  {
    "type": "SERVICE",
    "uid": "7b6425d4f0914f7e93f21e7ac9582c27",
    "name": "Data - Circuit Switched Data (CSD)"
  }
]
Name Description
offer.unknown Raised when no offer matches the 'uid'.
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions None

/api/v1/offers/options

Returns a list of available options

Request

GET https://na.airvantage.net/api/v1/offers/options

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
[
  {
    "type": "ROAMING",
    "uid": "43c9ea75020f4fa2b24ff4c9b8f4884c",
    "name": "AFRICA - Central"
  },
  {
    "type": "SERVICE",
    "uid": "7b6425d4f0914f7e93f21e7ac9582c27",
    "name": "Data - Circuit Switched Data (CSD)"
  }
]
Name Description Use Default Type Operand
company Set the context company. optional caller's company uid =
offer Returns all options linked to the given offer uid. optional null uid =
name Returns all options whose name matches the given string. optional null string =
exactMatch The name criterion behaves as LIKE when this parameter is set to false< optional true boolean
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions None
TOP