api:mvnoroamingpartners:list
Table of Contents
API : MVNO roaming partners List
Introduction
This request will return the list of all roaming partners.
Request
| URL | https://api.telecomx.dk/mvno/roamingpartner | |
|---|---|---|
| Method | GET | |
| Access level | ADMIN. | |
| Query | language | The language to localise country names for - allowed values are “da” and “en”. Defaults to Danish. |
Query examples
https://api.telecomx.dk/mvno/roamingpartner https://api.telecomx.dk/mvno/roamingpartner?language=en
Response
| JSON object | |
|---|---|
| total | Number of documents that are returned. |
| roamingPartners | Array of documents, see definition below |
| Document object (JSON) | ||
|---|---|---|
| _id | String | 5 char ID code for the telecom. |
| operator | String | 5 char ID code for the telecom. |
| country | string | Name of the country the telecom operates in. |
| countryCode | String | ISO3166-2 2-char country code. |
| code | Number | Operator code as used in billing data. |
| roamingRegions | Object | Roaming region the country belongs to, depending on mobile network. The key is the provider ID, and the value is the region. Keys can be “telenor”, or “tdc” |
| roamingRegions.<provider> | ObjectId | ID of roaming region |
Note that properties holding no value may be omitted from the object.
Example - normal
{ "total": 2, "roamingPartners": [ { "_id": "ABCDF", "operator": "Nordic Telecom", "country": "Sweden", "countryCode": "SE", "code": 77781, "roamingRegions": { "tdc": ObjectID('1234567890ABCD1234567890'), "telenor": ObjectID'12345678901234567890') } }, { "_id": "EFGHAS", "operator": "Polynesia Mobilea", "country": "French Polynesia", "countryCode": "PF", "code": 12345, "roamingRegions": { "tdc": ObjectID('1234567890ABCD1234567890'), "telenor": ObjectID'12345678901234567890') } } ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/mvnoroamingpartners/list.txt · Last modified: 2023/06/03 07:26 by Joakim Andersen