API : MVNO account : OTT : Get

Introduction

This request will return the specified MVNO account, with some miscellaneous details.

Request

URL	https://api.telecomx.dk/mvno/ott/ACCOUNT_ID
Method	GET
Param	ACCOUNT_ID	Id of the MVNO account (24 hex-char string) or E.164 phone number.
Query	token	The one-time token sent to the mobile number

Query example

https://api.telecomx.dk/mvno/ott/1234567890ABCDEF12345678
https://api.telecomx.dk/mvno/ott/1234567890ABCDEF12345678?token=12jahsd78127tubjsdf

Response

Json object
_id	Id	Unique MVNO account id.
number	String	The phone number in E.164 format.
info	Object	Informational - things that cannot be changed diretly by the user.
info.updating	Boolean	True if accounting is waiting to be updated and cannot be changed.
data	Array	Array of data usage data, see details below. Only “Homeland” and “Roam Like Home”-regions are included in this array.
data[].date	Date	The year/month the usage statistics is for.
data[].regions	Array	List of roaming regions
data[].regions[]._id	ObjectID	ID of roaming region
data[].regions[].name	String	Name of roaming region
data[].regions[].roamLikeHome	Boolean	Whether this is the “Roam Like Home”-region
data[].regions[].homeland	Boolean	Whether this is the “Homeland”-region
data[].regions[].bytes	Number	Amount of bytes used in this region
data[].regions[].bytes	Number	Amount of bytes included in the subscription for this region
products	Array	List of top-up products, which can be applied to this MVNO account
products[]._id	Id	Unique product id.
products[].type	String	Type of product. Always MVNO_DATA_TOP_UP.
products[].name	String	Product name.
products[].price	Number	The customer price, pr. month if recurring.
topUp	Object	Contains top-up properties
products[].topUp.data	Number	Data of the top-up package. Given in bytes

Note that properties holding no value may be omitted from the object.

Example

{
  _id: '1234567890ABCDEF12345678',
  number: '+4512345678',
  info: {
    updating: false
  },
  data: [
    {
      date: '2015-01-01T00:00:00.000Z',
      regions: [
        {
          _id: '1234567890ABCD1234567890',
          name: "Danmark",
          roamLikeHome: false,
          homeland: true,
          bytes: 1073741824,
          subscription: 2147483648
        }
      ]
    },
  ],
  products: [
    {
      _id: '1234567890ABCD1234567890',
      type: 'MVNO_DATA_TOP_UP',
      name: 'Data top-up 5 Gb',
      price: 75.00,
      topUp: {
        data: 5368709120
      }
    },
    {
      ...
    }
  ]
}

Errors

Error code	Message	Description
401	authentication_required	Invalid token
403	access_denied	Insufficient access level
404	id	MVNO account not found

WIKI

Table of Contents

API : MVNO account : OTT : Get

Introduction

Request

Query example

Response

Example

Errors