api:internet:request:get
Table of Contents
API : Internet Request Get
Introduction
This request will return a single Internet requests. Internet requests is the customer or reseller asking if a given speed and technology can be delivered at a given address.
Request
| URL | https://api.telecomx.dk/internet/request/:id | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller or a sub reseller. RESELLER_ADMIN ADMIN. |
|
| Params | :id | Id of the Internet Request to return. |
Query examples
https://api.telecomx.dk/internet/request/1234567890ABCDEF12345678
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. |
| reseller | Id | Id of the reseller that owns the request. |
| 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). |
| 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 offered solutions |
| offers[]._id | Id | Unique id of the offer. |
| offers[].product | Id | Product offered - describes speed and technology. |
| offers[].initiationFeeProduct | Id | Id of the product used for initiation |
| offers[].initiationCost | Number | Initiation price for TCX (FIBER only, RESELLER_ADMIN/ADMIN only). |
| offers[].initiationWholesale | Number | Initiation price for reseller (FIBER only, RESELLER/RESELLER_ADMIN/ADMIN only). |
| offers[].initiationCustomer | Number | Initiation price for customer (FIBER only). |
| offers[].monthlyCost | Number | Price pr. month for TCX (FIBER only, RESELLER_ADMIN/ADMIN only). |
| offers[].monthlyWholesale | Number | Price pr. month for reseller (FIBER only, RESELLER/RESELLER_ADMIN/ADMIN only). |
| offers[].monthlyCustomer | Number | Price pr. month for customer (FIBER only). |
| offers[].commitment | Number | Number of months before the account can be cancelled. |
| offers[].providerName | String | Name of the provider (RESELLER_ADMIN/ADMIN only). |
| offers[].providerOfferId | String | Id of the providers offer (RESELLER_ADMIN/ADMIN only). |
| offers[].notes | String | Notes from the reseller about this offer (max 1024 characters). |
| created | Date | Date and time when the request was created. |
| createdBy | Id | Id of employee who created the request. |
| answered | Date | Date and time when the request was answered (offers expires 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": "In stairwell behind the door", "address": { "_id": "650000000000000000000004", "address": "Eksempelvej 20A, 3. th.", "zip": 2605, "city": "Brøndby" }, "address2": null, "product": "650000000000000000000005", "ipAddresses": 8, "commitment1": true, "commitment2": true, "commitment3": true, "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_12", "offers": [ { "_id": "650000000000000000000009", "product": "650000000000000000000010", "initiationFeeProduct": "650000000000000000000011", "initiationCost": 1000, "initiationWholesale": 2000, "initiationCustomer": 3000, "monthlyCost": 500, "monthlyWholesale": 600, "monthlyCustomer": 700, "commitment": 36, "providerName": "Eksempel Fiber A/S", "providerOfferId": "4656367R", "notes": "" } ], "created": "2026-08-01T00:00:00.000Z", "createdBy": "650000000000000000000006", "answered": "2026-08-02T12:00:00.000Z" }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | not_found | Internet request not found |
| 500 | internal_error | <Unspecified> |
api/internet/request/get.txt · Last modified: by Mikkel Meerwaldt Jørgensen