API : Internet Request List

Introduction

Internet requests is the customer or reseller asking if a given speed and technology can be delivered at a given address.

This request will return a list of Internet requests.

Request

URL	https://api.telecomx.dk/internet/request
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. ADMIN.
Query	customer	Id of the customer the Internet requests belongs to, defaults to users own customer, if reseller is not given.
	reseller	Id of reseller the Internet requests belongs to (requests not bound to a specific customer).
	offset	`[optional]` Index of the first Internet request to return, default 0.
	limit	`[optional]` The number of Internet request to return, default 100, min 1, max 500.
	filter	`[optional]` To filter the Internet requests, this can be used. This will look for installation addresses.
	state	`[optional]` State filter: ANY - returns all, NEW - items without offer, HAS_OFFER - items with offers.
	full	`[optional]` If true, complete Internet requests will be returned instead of the condensed version.

Query examples

https://api.telecomx.dk/internet/request?customer=1234567890ABCDEF12345678
https://api.telecomx.dk/internet/request?reseller=1234567890ABCDEF12345679
https://api.telecomx.dk/internet/request?customer=1234567890ABCDEF12345678&filter=Glostrup&offset=10&limit=25&full=true

Response

JSON object
Property	Type	Description
offset	Number	Index of the first Internet request returned.
limit	Number	Number of Internet requests to return. Note that the actual number of Internet accounts returned may be lower.
total	Number	Number of Internet requests that can be returned when offset and limit is not considered. This is to be used for paging through the data.
requests	Array	List of Internet requests, see definition below.

Internet request object (JSON)
Property	Type	Description
_id	Id	Unique id of the Internet 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 reseller.
address	String	Installation address.
product	Id	Id of the product requested.
productName	String	Name of the requested product.
reference	String	A reference id, name, customer name.
offers	Boolean	True if offers has been made.
created	Date	Date and time when the request was created.
createdBy	Id	Id of employee who created the request.
createdByName	String	Name of the employee who created the request.

Internet request object if full=true (JSON)
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 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).
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

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 id's of employees to notify by e-mail when request has been answered.
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).
offers[].initiationWholesale	Number	Initiation price for reseller (FIBER only).
offers[].initiationCustomer	Number	Initiation price for customer (FIBER only).
offers[].monthlyCost	Number	Price pr. month for TCX (FIBER only).
offers[].monthlyWholesale	Number	Price pr. month for reseller (FIBER 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.
offers[].providerOfferId	String	Id of the providers offer.
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 - normal

{
  offset: 10,
  limit: 20,
  total: 123,
  requests:
  [
    {
      _id: '1234578901234567890AAAA',
      type: 'FIBER',
      customer: '1234567890123456780BBBB',
      reseller: '12345678901234567890CCCC',
      address: 'Vallensbækvej 20A, 3. th., 2605 Brøndby',
      product: '12345678901234567890DDDD',
      productName: 'Fiber city ring 100Mbit',
      referenceId: 'SS-545665',
      offers: true,
      created: '2016-01-01T00:00:00Z',
      createdBy: '1234567890124567890EEEE',
      createdByName: 'Hans Christian Anderson'
    },
    ...
  ]
}

Example - full=true

{
  offset: 10,
  limit: 20,
  total: 123,
  requests:
  [
    {
      _id: '123457890123457890AAAA',
      type: 'FIBER',
      customer: '12345678901234567890BBBB',
      reseller: '1234567890123457890CCCC',
      notes: 'In stairwell behind the door',
      address: {
        _id: '12345678901234567890DDDD',
        address: 'Vallensbækvej 20A 3. th.',
        zip: '2605',
        city: 'Brøndby'
      },
      address2: null,
      product: '12345678901234567890EEEE',
      takeover: true,
      takeoverCircuit: 'fake347465',
      takeoverCustomer: '5646756475',
      ipAddresses: 8,
      commitment1: true,
      commitment2: true,
      commitment3: true,
      reference: 'Donald Duck',
      notify: [ '12345678901234567890FEDD' ],
      startDate: '2018-01-01T00:00:00.000Z',
      installCallNumber: '71919999',
      installCallName: 'Donald',
      installTime: '7_30_TO_12',
      Offers: [
        {
          _id: '12345678901234567890FFFF',
          product: '1234567890123457890AABB',
          initiationFeeProduct: '1234567890124567890AACC',
          initiationCost: 1000,
          initiationWholesale: 2000,
          initiationCustomer: 3000,
          monthlyCost: 500,
          monthlyWholesale: 600,
          monthlyCustomer: 700,
          commitment: 36,
          providerName: 'Nianet',
          providerOfferId: '4656367R'
        },
        {
          ...
        }
      ],
      created: '2018-01-01T00:00:00.000Z',
      createdBy: '1234567890123457890FEDE',
      answered: '2018-01-01T12:00:00.000Z'
    },
    {
      ...
    }
  ]
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents