User Tools

Site Tools


api:dk:operator:create

API : DK Operator Create

Introduction

This request will create a Danish Telecom Operator.

Request

URL https://api.telecomx.dk/dk/operator
Method POST
Access level ADMIN.
Body _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.

Query examples

{
  _id: ObjectID('1234567890ABCDEF12345678'),
  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
}

Response

The newly created operator.

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 [optional] Number porting fax number.
npEmail String [optional] Number porting e-mail address.
npOpeningHours String [optional] When is number porting open for personal contact.
notes String [optional] 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 [optional] If using ICC validation, this the the RegEx to validate input with.
orderWait Integer [optional] 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

{
  _id: ObjectID('1234567890ABCDEF12345678'),
  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
422 _id Id is not valid
404 name Name is missing
404 address Address is missing
422 npNumber NP phone number is not a valid phone number
422 npEmail NP e-mail address is not a valid e-mail address
422 fixedAuth Fixed authentication method is not recognized
422 mvnoAuth MVNO authentication method is not recognized
422 orderWait Order wait time must be a whole number of hours to wait
409 _id Operator already exists
403 access_denied Insufficient access level
500 internal_error <Unspecified>
api/dk/operator/create.txt · Last modified: 2014/06/07 09:59 by Per Møller

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki