Table of Contents

API : MVNO roaming partners List

Introduction

This request returns the MVNO roaming partners: the mobile operators abroad whose networks our MVNO subscriptions may roam on, sorted by operator name.

Request

URL https://api.telecomx.dk/mvno/roamingpartner
Method GET
Access level RESELLER_ADMIN with the FINANCE employee feature.
ADMIN.
Query offset [optional] Index of the first partner to return, default 0.
limit [optional] The number of partners to return, default 100, min 1, max 500.
language [optional] The language of the country names. Allowed values are da, en. Defaults to da.

Query examples

https://api.telecomx.dk/mvno/roamingpartner
https://api.telecomx.dk/mvno/roamingpartner?language=en&offset=100&limit=100

Response

JSON object
offset Index of the first partner returned.
limit Number of partners to return. Note that the actual number of partners returned may be lower.
total Number of partners that can be returned when offset and limit is not considered. This is to be used for paging through the data.
roamingPartners Array of partners, see definition below
Field Type Description
_id String The operator's 5 character ID code.
operator String Operator name.
country String Name of the country the operator is stored with, in the requested language. A country with no name in the requested language gives its first known name, and a country unknown to the platform gives the stored English name. Absent when no country is stored.
countryCode String ISO 3166 two-letter country code.
code Number Operator code as used in the billing data.
region String Region the country belongs to. Allowed values are euNordic, restOfEurope, world1, world2, world3. Absent when the partner was saved without a region.

Example

{
  offset: 0,
  limit: 100,
  total: 2,
  roamingPartners: [
    {
      _id: 'XMPLA',
      operator: 'Example Mobile',
      country: 'Sverige',
      countryCode: 'SE',
      code: 24099,
      region: 'euNordic'
    },
    {
      _id: 'XMPLB',
      operator: 'Sample Telecom',
      country: 'Fransk Polynesien',
      countryCode: 'PF',
      code: 54799,
      region: 'world3'
    }
  ]
}

Errors

Error code Message Description
403 access_denied A minimum access level of 'RESELLER_ADMIN' required
403 access_denied Employees does not have the required feature FINANCE
500 internal_error <Unspecified>