API : Internet Accounts List

Introduction

This request will return the list of Internet Access accounts (fiber/xDSL) that belongs to a customer.

Request

URL	https://api.telecomx.dk/internet/account
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	`[optional]` Id of the customer to list accounts for, defaults to users own customer if reseller is not set.
	reseller	`[optional]` Id of the reseller whose customers to list accounts for.
	offset	`[optional]` Index of the first account to return, default 0.
	limit	`[optional]` The number of accounts to return, default 100, min 1, max 500.
	state	`[optional]` Only return accounts with a specific state: ORDERED, CONFIRMED, ACTIVE, CANCELLED.
	changerequest	`[optional]` Only return accounts with a change request at a specific state: REQUESTED, ORDERED.
	filter	`[optional]` Filter accounts on properties like address, circuit id, IP address and notes.
	full	`[optional]` If true, return full accounts instead of the condensed version.
	up	`[optional]` If true, return only accounts that are up. If false, return only accounts that are down. If not set, return accounts regardless of up/down status.
	csv	`[optional]` If true, returns data in CSV format instead of JSON.

Query examples

https://api.telecomx.dk/internet/account?customer=1234567890ABCDEF12345678
https://api.telecomx.dk/internet/account?customer=1234567890ABCDEF12345678&filter=EM123456&offset=10&limit=25&full=true

Response

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

Internet account
Property	Type	Description
_id	Id	Unique id of the account.
type	String	Type of circuit: DSL or FIBER.
state	String	State of account: ORDERED - customer/reseller has ordered the account CONFIRMED - the account has been confirmed for delivery on the specified date ACTIVE - the account is in active use CANCELLED - the account has been cancelled and will terminate on the specified date.
address	Id	Id of the address where the Internet account is installed.
addressName	String	Address where the Internet account is installed.
circuit	String	Id of the circuit.
product	Id	Id of the product.
productName	String	Name of the product.
orderDate	Date	Date when ordered.
startDate	Date	Date when account goes live/went live.
terminationDate	Date	Date when account will be taken down.
ipAddress	String	Assigned IP address.
up	Boolean	True if the accounts ipAddress is online/pingable.

Internet account if full=true
Property	Type	Description
_id	Id	Unique id of the Internet account.
type	String	Type of circuit: DSL or FIBER.
state	String	State of product:
		ORDERED - customer/reseller has ordered the account.
		CONFIRMED - the account has been confirmed for delivery on the specified date.
		ACTIVE - the account is in active use.
		CANCELLED - the account has been cancelled and will terminate on the specified date.
customer	Id	Id of customer the account belongs to.
orderedBy	Id	Id of the employee who ordered the account.
address	Id	Id of installation address
address2	Id	Id of installation address2 (if it is a point-2-point account).
circuit	String	Id of the circuit.
product	Id	Id of the product, that is invoiced.
initiationFeeProduct	Id	Id of the product invoiced for establishing the account.
takeover	Boolean	True if account is a takeover from another provider (type DSL only).
takeoverCustomer	String	Id of customer at provider the takeover is from (type DSL only).
orderDate	Date	Date the account was ordered.
startDate	Date	When state is ORDERED, the requested start date, otherwise the date the account will go/went live.
terminationDate	Date	If state is CANCELLED, the date the account will terminate, when approved.
requestedTerminationDate	Date	If state is CANCELLED, the date the customer wants the account to be terminated.
commitmentExpireDate	Date	The earliest date on which the account may be terminated according to the provider's contract.
commitmentExpireDateCustomer	Date	The earliest date on which the account may be terminated according to the customer's contract
invoicedUntil	Date	The date the account has been invoiced until.
installCallNumber	String	Number that technician will call 30 minutes before arriving to install the service.
installCallName	String	Name of person technician will call 30 minutes before arriving to install the service.
installTime	String	Time of day installation will be performed: 7_30_TO_16, 7_30_TO_12, 12_TO_16.
provider	Object
provider.name	String	Name of the subcontractor providing the circuit (ADMIN only).
provider.orderId	String	Subcontractors order id (ADMIN only).
provider.invoicedUntil	Date	The date until when the provider has invoiced TCX for the account (ADMIN only).
provider.ipAddresses	Number	Number of IP addresses ordered for the account (ADMIN only).
fiber	Object
fiber.initiationCost	Number	Installation cost (type FIBER only) (ADMIN only).
fiber.initiationWholesale	Number	Reseller installation price (type FIBER only) (RESELLER only).
fiber.initiationCustomer	Number	Customer installation price (type FIBER only).
fiber.monthlyCost	Number	Monthly fee cost (type FIBER only) (ADMIN only).
fiber.monthlyWholesale	Number	Monthly fee reseller (type FIBER only) (RESELLER only).
fiber.monthlyCustomer	Number	Monthly fee customer (type FIBER only).
changeRequest	Object
changeRequest.state	String	State of change request: NONE, REQUESTED, ORDERED.
changeRequest.product	Id	New product/speed customer wishes to change to.
changeRequest.by	Id	Id of employee who requested the change and who will be notified.
changeRequest.date	Date	The date the change will happen.
changeRequest.feeProduct	Id	Id of product for change fee.
changeRequest.monthlyCost	Number	New monthly fee cost (type FIBER only) (ADMIN only).
changeRequest.monthlyWholesale	Number	New monthly fee reseller (type FIBER only) (RESELLER only).
changeRequest.monthlyCustomer	Number	New monthly fee customer (type FIBER only).
net	Object
net.ipAddress	String	Assigned IP address.
net.subnet	String	Assigned subnet mask.
net.gateway	String	Assigned default gateway.
net.lanNet	String	If an additional network is assigned, this is the first IP address in the range.
net.lanSubnet	String	If an additional network is assigned, this is the subnet mask of the range.
net.failover	Boolean	True if this line has 3G/4G failover.
net.failoverNumber	String	Phone number of failover SIM, if net.failover is true.
net.up	Boolean	True if the accounts ipAddress is online/pingable.

notes	String	Note about the service (RESELLER/ADMIN only).
documents	Array	List of id's of documents related to the account.
custom	Object	Optional custom data that 3rd parties may append, max. 4Kb.
notify	Array
notify._id	Id	Id of employee to notify when the account goes online/offline.
notify.email	Boolean	True to notify via e-mail.
notify.sms	Boolean	True to notify via SMS.

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

Example - normal

{
  offset: 10,
  limit: 20,
  total: 123,
  accounts:
  [
    {
      _id: '12345678901234567890ABCD',
      type: 'FIBER',
      state: 'ACTIVE',
      address: '1234567890124567890AAAA',
      addressName: 'Vallensbækvej 20A, 3. th., 2605 Brøndby',
      circuitId: 'HB123456',
      product: '12345678901234567890BBBB',
      productName: 'Fiber 100/100 City ring',
      orderDate: '2016-01-02T00:00:00Z',
      startDate: '2016-02-01T00:00:00Z',
      terminationDate: null,
      ipAddress: '77.66.100.123',
      up: true
    },
    {
      ...
    }
  ]
}

Example - full=true

{
  _id: '12345678901234567890AAAA',
  type: 'FIBER',
  state: 'ACTIVE',
  customer: '12345678901234567890BBBB',
  orderedBy: '12345678901234567890FEDE',
  address: '12345678901234567890CCCC',
  circuit: 'HB123456',
  takeoverCustomer: null,
  provider: {
    name: 'TDC',
    orderId: '56326R47723',
    invoicedUntil: '2016-04-01T00:00:00Z',
    ipAddresses: 4
  },
  product: '12345678901234567890DDDD',
  fiber: {
    installCost: 800.00,
    installWholesale: 900.00,
    installPrice: 1000.00,
    monthlyCost: 1500.00,
    monthlyWholesale: 1600.00,
    monthlyPrice: 1700.00,
  },
  orderDate: '2016-01-01T00:00:00Z',
  startDate: '2016-01-14T00:00:00Z',
  terminationDate: null,
  requestedTerminationDate: null,
  commitmentExpireDate: '2016-06-14T00:00:00Z',
  commitmentExpireDateCustomer: '2016-06-14T00:00:00Z',
  invoicedUntil: '2016-03-01T00:00:00Z',
  installCallNumber: '71919999',
  installCallName: 'Donald Duck',
  changeRequest: {
    state: 'REQUESTED',
    product: '12345678901234567890AABB',
    by: '12345678901234567890EEEE',
    date: '2016-02-01T00:00:00Z',
    feeProduct: '12345678901234567890AACC',
    monthlyCost: 2300.00,
    monthlyWholesale: 2400.00,
    monthlyPrice: 2500.00
  },
  net: {
    ipAddress: '77.66.100.123',
    subnet: '255.255.255.128',
    gateway: '77.66.100.1',
    lanNet: '77.66.100.128',
    lanSubnet: '255.255.255.240',
    failover: true,
    failoverNumber: '+4571919930',
    up: true
  },
  notes: 'Very important customer',
  search: 'vallensbækvej 20a 3 th 2605 brøndby HB123456 464356236 81808888 per 77.66.100.123 77.66.100.1 77.66.100.128 very important customer',
  documents: [ '12345678901234567890FFFF' ],
  custom: null,
  notify: [
    {
      _id: '12345678901234567890FEDE',
      email: true,
      sms: false
    },
    {
      ...
    }
  }
}

Errors

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

WIKI

Table of Contents

API : Internet Accounts List

Introduction

Request

Query examples

Response

Example - normal

Example - full=true

Errors