Table of Contents

API : DK Operators List

Introduction

This request will return a list of all the danish telecom operators.

Request

URL https://api.telecomx.dk/dk/operator
Method GET
Access level VIEWER, MANAGER, OWNER, RESELLER - can only see _id, name and address.
RESELLER_ADMIN, ADMIN - Full.
Query filter [optional] Search keyword that will be used against the operator name, the notes and id.
offset [optional] Index of the first operator to return, default 0.
limit [optional] The number of operators to return, default 100, min 1, max 1000.

Query examples

https://api.telecomx.dk/dk/operator

Response

JSON object
offset Index of the first operator returned.
limit Number of operators to return. Note that the actual number of operators returned may be lower.
total Number of operators that can be returned when offset and limit is not considered. This is to be used for paging through the data.
operators Array of operators, see definition below.
Operator object (JSON)
_id String Service Operator 5 digit CPS code.
name String Name of operator.
address String Postal address.
npNumber String Number porting service number.
npFax String Number porting fax number.
npEmail String Number porting e-mail address.
npOpeningHours String When is number porting open for personal contact.
notes String Notes about the operator.
fixedAuth String How to auth for fixed lines: FAX or EMAIL.
mvnoAuth String How to auth for mvno: ICC, ICC_FAX, ICC_EMAIL, FAX or EMAIL.
iccValidation String If using ICC validation, this is the RegEx to validate input with.
customerIdValidation Boolean True if operator requires customer id validation.
shortCode Integer Server-assigned operator ID (0-255). Read-only

Example

{
  "offset": 0,
  "limit": 100,
  "total": 2,
  "operators": [
    {
      "_id": "01234",
      "name": "Operator ApS",
      "address": "Eksempelvej 1, 2500 Valby",
      "npNumber": "+4571919900",
      "npFax": "+4571919901",
      "npEmail": "np@example.dk",
      "npOpeningHours": "man-fre 8:00-16:00",
      "notes": "Contact the porting desk by e-mail",
      "fixedAuth": "EMAIL",
      "mvnoAuth": "ICC_EMAIL",
      "iccValidation": "^894501\\d{13}$",
      "customerIdValidation": false,
      "shortCode": 20
    },
    {
      "_id": "04321",
      "name": "Eksempel Telecom A/S",
      "address": "Prøvegade 2, 8000 Aarhus C",
      "npNumber": "+4571919902",
      "npEmail": "porting@example.dk",
      "fixedAuth": "FAX",
      "mvnoAuth": "ICC",
      "customerIdValidation": true,
      "shortCode": 21
    }
  ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>