api:dk:operator:list
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 name and address. ADMIN. |
|
| Query | filter | [optional] Search keyword that will be used against the operator name and the notes. |
| offset | [optional] Index of the first employee to return, default 0. |
|
| limit | [optional] The number of employees to return, default 100, min 1, max 500. |
|
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 the the RegEx to validate input with. |
| orderWait | Integer | If the operator requires auth to be sent and then a wait period before porting is ordered, then this is the number of hours to wait, null if not used. |
| customerIdValidation | Boolean | True if operator requires customer id validation. |
Example
{ offset: 0, limit: 100, total: 139, operators: [ { _id: '01060', name: 'Telecom X', address: 'Frugtmarkedet 17, 2500 Valby', npNumber: '+4570305000', npFax: '+4570305051', npEmail: 'np@telecomx.dk', npOpeningHours: 'man-fre 8:00-16:00', notes: 'Ask for Rune', fixedAuth: EMAIL, mvnoAuth: ICC_EMAIL, iccValidation: '/^894512\d{13}F$/', orderWait: null, customerIdValidation: false }, { ... } ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/dk/operator/list.txt · Last modified: 2014/07/21 13:33 by Per Møller