User Tools

Site Tools


api:dk:operator:get

API : DK Operator Get

Introduction

This request will return a single Danish Telecom Operator.

Request

URL https://api.telecomx.dk/dk/operator/OPERATOR_ID
Method GET
Access level VIEWER, MANAGER, OWNER, RESELLER - can only see _id, name and address.
RESELLER_ADMIN, ADMIN - Full.
Param OPERATOR_ID Operators CPS code - 5 characters.

Query examples

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

Response

JSON object
_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

{
  "_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
}

Errors

Error code Message Description
403 access_denied Insufficient access level
404 id Operator not found
422 id 5-digit operator code
500 internal_error <Unspecified>
api/dk/operator/get.txt · Last modified: by Mikkel Meerwaldt Jørgensen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki