API : Internet Request Create

Introduction

This request will create a request for Internet Access. It is used to ask for if a given technology/speed can be delivered at a given address and which the initiation and monthly price will be.

Request

URL	https://api.telecomx.dk/internet/request
Method	POST
Access level	MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller or a sub reseller. RESELLER_ADMIN ADMIN.
	Property	Type	Description
Body	type	String	Type of circuit: DSL or FIBER - Defaults to DSL when omitted
	customer	Id	Id of customer, if linked to a customer - otherwise null.
	notes	String	Notes about the request. Max length of 4096.
	address	Object	`[required]` Installation address
	address._id	Id	Unique ID of the address, if using existing address on customer.
	address.address	String	`[required]` Road, number, floor, door
	address.zip	Number	`[required]` Zip code, 4 digits (1000-9999)
	address.city	String	`[required]` City name
	address2	Object	Second address. For specific products. Point-to-Point connections. (FIBER only).
	address2._id	Id	Unique ID of the address, if using existing address on customer
	address2.address	String	Road, number, floor, door
	address2.zip	Number	Zip code, 4 digits (1000-9999)
	address2.city	String	City name

	product	Id	`[required]` Id of the product
	takeover	Boolean	True if this is a takeover (DSL only).
	takeoverCircuit	String	Name of existing circuit, if takeover (DSL only).
	takeoverCustomer	String	Customer ID/number at donor operator, if takeover (DSL only).
	ipAddresses	Number	Number of IP addresses: 1, 2, 4, 8, 16 or 32 (FIBER only). Default 1.
	commitment1	Boolean	True to get an offer for a 1 year commitment (FIBER only). When none of commitment1-3 is true on a FIBER request, offers for all three are requested.
	commitment2	Boolean	True to get an offer for a 2 year commitment (FIBER only).
	commitment3	Boolean	True to get an offer for a 3 year commitment (FIBER only).
	reference	String	A reference id/name/customer.
	notify	Array	List of id's of employees to notify by e-mail when request has been answered. When empty or omitted, the creating employee is subscribed automatically.
	startDate	Date	`[optional]` Desired date for delivery of the Internet Access account, between 1 month ago and 6 months into the future. Omit for as soon as possible.
	installCallNumber	String	Number that technician will call 30 minutes before arriving to install the service.
	installCallName	String	Name of contact to call.
	installTime	String	Wanted time of delivery: 7_30_TO_16, 7_30_TO_12 or 12_TO_16. Default 7_30_TO_16.

Query examples

{
  "type": "FIBER",
  "customer": "650000000000000000000002",
  "address": {
    "address": "Eksempelvej 20A, 3. th.",
    "zip": 2605,
    "city": "Brøndby"
  },
  "product": "650000000000000000000005",
  "commitment1": true,
  "commitment2": true,
  "commitment3": false,
  "ipAddresses": 32,
  "reference": "REQ-2026-0117",
  "notify": [ "650000000000000000000006" ],
  "notes": "Main building on the right",
  "startDate": "2026-09-01T00:00:00.000Z",
  "installCallNumber": "71919999",
  "installCallName": "Hans Eksempel",
  "installTime": "7_30_TO_16"
}

Response

Property	Type	Description
_id	Id	Unique id of the request.
type	String	Type of circuit: DSL or FIBER
customer	Id	Id of customer, if linked to a customer - otherwise null. Absent when not sent in the request.
reseller	Id	Id of reseller, if not linked to a customer, the request belongs to the reseller.
notes	String	Notes about the request
address	Object	Installation address
address._id	Id	Unique ID of the address, if using existing address on customer.
address.address	String	Road, number, floor, door
address.zip	Number	Zip code
address.city	String	City name
address2	Object	Second address. For specific products. Point-to-Point connections. (FIBER only). Absent when not sent in the request.
address2._id	Id	Unique ID of the address, if using existing address on customer
address2.address	String	Road, number, floor, door
address2.zip	Number	Zip code
address2.city	String	City name

product	Id	Id of the product
takeover	Boolean	True if this is a takeover (DSL only).
takeoverCircuit	String	Name of existing circuit, if takeover (DSL only).
takeoverCustomer	String	Customer ID/number at donor operator, if takeover (DSL only).
ipAddresses	Number	Number of IP addresses. (1, 2, 4, 8, 16, 32) (FIBER Only)
commitment1	Boolean	True to get an offer for a 1 year commitment (FIBER only).
commitment2	Boolean	True to get an offer for a 2 year commitment (FIBER only).
commitment3	Boolean	True to get an offer for a 3 year commitment (FIBER only).
reference	String	A reference id/name/customer.
notify	Array	List of employees to notify by e-mail when request has been answered.
notify[]._id	Id	Id of employee.
notify[].name	String	Name of employee.
startDate	Date	[optional] Desired date for delivery of the Internet Access account, omit for as soon as possible.
installCallNumber	String	Number that technician will call 30 minutes before arriving to install the service.
installCallName	String	Name of contact to call.
installTime	String	Wanted time of delivery Valid values 7_30_TO_16, 7_30_TO_12, 12_TO_16
offers	Array	List of offers - always empty on a newly created request.
created	Date	Date and time when the request was created.
createdBy	Id	Id of employee who created the request.
answered	Date	Not present on a newly created request. Set when the first offer is added (offers expire 30 days after this date).

Note that properties holding no value may be omitted from the object.

Example

{
  "_id": "650000000000000000000001",
  "type": "FIBER",
  "customer": "650000000000000000000002",
  "reseller": "650000000000000000000003",
  "notes": "Main building on the right",
  "address": {
    "address": "Eksempelvej 20A, 3. th.",
    "zip": 2605,
    "city": "Brøndby"
  },
  "product": "650000000000000000000005",
  "ipAddresses": 32,
  "commitment1": true,
  "commitment2": true,
  "commitment3": false,
  "reference": "REQ-2026-0117",
  "notify": [ { "_id": "650000000000000000000006", "name": "Hans Eksempel" } ],
  "startDate": "2026-09-01T00:00:00.000Z",
  "installCallNumber": "71919999",
  "installCallName": "Hans Eksempel",
  "installTime": "7_30_TO_16",
  "offers": [],
  "created": "2026-08-06T10:00:00.000Z",
  "createdBy": "650000000000000000000006"
}

Errors

Error code	Message	Description
422	<property>	Invalid input for the named property - the request body, query or URL parameter failed validation
422	product	Product is required
422	address.address	Address is required
422	address.zip	Zip code is required
422	address.city	City is required
404	address._id	Address not found
404	address2._id	Address not found
404	notify[n]	Recipient not found
422	product	Product is not valid for customer
422	product	Product not found
422	product	Product(s) is not valid for use
422	takeoverCircuit	Circuit is required for takeover
422	takeoverCustomer	Customer id is required for takeover
422	ipAddresses	IP address is required and must be 1, 2, 4, 8, 16 or 32
422	startDate	Date must be between 1 month ago and 6 months into the future
422	multiple	Multiple errors - see inner
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents