API : MVNO roaming partners Upload
- Introduction
- Request
  - Query examples
- Response
  - Example
  - Errors

API : MVNO roaming partners Upload

Introduction

This request reads the operator's roaming partner Excel sheet and returns its partners as JSON, with country, code and region resolved, plus the rows it could not read. Nothing is stored: send the partners to Update to save them.

Request

URL	https://api.telecomx.dk/mvno/roamingpartner/upload
Method	POST
Access level	RESELLER_ADMIN with the FINANCE employee feature. ADMIN.
Body	multipart/form-data
Property	Type	Description
file	File	The roaming partner sheet: an .xls or .xlsx file whose name contains “roaming”.

The first sheet is read from its third row, with the columns in this order: operator name, country, operator ID, operator code, region.

Country: one or more English country names, comma separated. A row naming one country is stored with it. A row naming several is stored with Monaco when it is listed, otherwise with the first of FR, AI, GF, GE, US, ES, PT, MM, IN in the row's order. A row whose country cannot be resolved this way fails the whole upload with the country error below.
Region: one of the operator's region names below. An empty cell gives world3; a name not in the list gives no region.

Region name in the sheet	Region
EU & EEA North Atlantic Western Europe (exept EU & EEA) Western Low	euNordic
Eastern Europe and Turkey Eastern Europe Western High	restOfEurope
North America North America, Thailand & Turkey USA Thailand World Low	world1
Rest of the World, Group 1 World Medium	world2
Rest of the World, Group 2 World High	world3

A row is read as a partner when it has a country, an operator ID without spaces and an operator code of digits only. Any other row is returned in invalidRoamingPartners as it was read.

Query examples

https://api.telecomx.dk/mvno/roamingpartner/upload

Response

JSON object
total	Number of partners read.
roamingPartners	Array of partners, see definition below
invalidRoamingPartners	Array of the rows that could not be read, as they were read: the cells operator, country, _id, code and region, each a String, present only when the cell has a value.

Field	Type	Description
_id	String	The operator's ID code.
operator	String	Operator name. Absent when the cell is empty.
country	String	English name of the country the operator is stored with.
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 sheet's region name is not in the list above.

Example

{
  total: 2,
  roamingPartners: [
    {
      _id: 'XMPLA',
      operator: 'Example Mobile',
      country: 'Sweden',
      countryCode: 'SE',
      code: 24099,
      region: 'euNordic'
    },
    {
      _id: 'XMPLB',
      operator: 'Sample Telecom',
      country: 'French Polynesia',
      countryCode: 'PF',
      code: 54799,
      region: 'world3'
    }
  ],
  invalidRoamingPartners: [
    {
      operator: 'Broken Row',
      country: 'Sweden',
      _id: 'XMPL C',
      code: '24098'
    }
  ]
}

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
422	file.invalid_name	File type or name invalid
422	country	Country <country cell> of <operator ID> not found
500	internal_error	<Unspecified>

Table of Contents