API : Roaming : Region List

Introduction

This request will return the list of regions.

Request

URL	https://api.telecomx.dk/roaming/region
Method	GET
Access level	VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN or ADMIN. Users below RESELLER_ADMIN only receive _id, names, homeland, roamLikeHome and network.
Query	filter	`[optional]` Filters regions by name
	network	`[optional]` Filters on network. Allowed values are TDC, TELENOR.
	offset	`[optional]` Index of the first region to return, default 0.
	limit	`[optional]` The number of regions to return, default 100, min 1, max 500.

Query examples

https://api.telecomx.dk/roaming/region
https://api.telecomx.dk/roaming/region?filter=Europa
https://api.telecomx.dk/roaming/region?filter=Europa&network=TDC

Response

JSON object
offset	Index of the first region returned.
limit	Number of regions to return. Note that the actual number of regions returned may be lower.
total	Number of regions that can be returned when offset and limit is not considered. This is to be used for paging through the data.
regions	Array of regions, see definition below

The notes, sms, data and voice properties are only included for RESELLER_ADMIN and ADMIN.

Field	Type	Description
_id	ObjectID	Id
names	Array	List of names, used for localization
names[].language	String	Two-letter language code. Allowed values are da, en.
names[].text	String	The localization of the region name (2-50 characters)
network	String	Which network this region belongs to. Allowed values are TELENOR, TDC.
roamLikeHome	Boolean	Whether this region allows roam like home - for now, only used for EU countries.
homeland	Boolean	Whether this region is a “homeland” region. For now it's only used for Denmark.
notes	String	Notes if necessary (max 512 characters)
sms	Object	SMS properties
sms.cost	Number	Cost price for SMS's in this region
sms.wholesale	Number	Wholesale price for SMS's in this region
sms.price	Number	Customer price for SMS's in this region
data	Object	Data properties
data.cost	Number	Cost price per megabyte data usage in this region
data.wholesale	Number	Wholesale price per megabyte data usage in this region
data.price	Number	Customer price per megabyte data usage in this region
voice	Object	Voice properties
voice.inbound	Object	Inbound voice properties
voice.inbound.rateCost	Number	Cost price per minute, when receiving a call in this region
voice.inbound.rateWholesale	Number	Wholesale price per minute, when receiving a call in this region
voice.inbound.rate	Number	Customer price per minute, when receiving a call in this region
voice.outbound	Array	List of regions, with the prices for calling them.
voice.outbound[]._id	ObjectId	ID of region
voice.outbound[].connectionFeeCost	Number	Cost price for starting a call to this region
voice.outbound[].connectionFeeWholesale	Number	Wholesale price for starting a call to this region
voice.outbound[].connectionFee	Number	Customer price for starting a call to this region
voice.outbound[].rateCost	Number	Cost price per minute, when calling this region
voice.outbound[].rateWholesale	Number	Wholesale price per minute, when calling this region
voice.outbound[].rate	Number	Customer price per minute, when calling this region

Example

{
  "offset": 0,
  "limit": 100,
  "total": 8,
  "regions": [
{
  "_id": "650000000000000000000001",
  "names": [
    { "language": "da", "text": "EU & Vesteuropa" },
    { "language": "en", "text": "EU & Western Europe" }
  ],
  "network": "TELENOR",
  "roamLikeHome": true,
  "homeland": false,
  "notes": "All EU and EEA countries",
  "sms": { "cost": 0.05, "wholesale": 0.06, "price": 0.07 },
  "data": { "cost": 0.078, "wholesale": 0.082, "price": 0.09 },
  "voice": {
    "inbound": { "rateCost": 0.1, "rateWholesale": 0.15, "rate": 0.18 },
    "outbound": [
      {
        "_id": "650000000000000000000002",
        "connectionFeeCost": 0.15,
        "connectionFeeWholesale": 0.19,
        "connectionFee": 0.21,
        "rateCost": 0.1,
        "rateWholesale": 0.15,
        "rate": 0.18
      }
    ]
  }
}
  ]
}

Errors

Error code	Message	Description
403	access_denied	A minimum access level of 'VIEWER' required
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : Roaming : Region List

Introduction

Request

Query examples

Response

Example

Errors