api:internet:account:change-request
Table of Contents
API : Internet Account Request Change
Introduction
This will request a change of product (speed) on a DSL Internet account.
Request
| URL | https://api.telecomx.dk/internet/account/ACCOUNT_ID/change/request | ||
|---|---|---|---|
| Method | POST | ||
| Access level | OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller or a sub reseller. ADMIN. |
||
| Params | ACCOUNT_ID | Id | Id of the Internet Access account. |
| Body | newProduct | Id | New product the customer/reseller wishes to change to. |
| 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. | |
Query examples
{ newProduct: '12345678901234567890AAAA', installCallNumber: '47823562', installCallName: 'Hans Hansen' }
Response
The created change request.
| Property | Type | Description |
|---|---|---|
| changeRequest.state | String | State of change request: NONE, REQUESTED, CONFIRMED. |
| changeRequest.product | Id | New product customer wishes to change to. |
| changeRequest.by | Id | Id of employee who requested the change and who will get an e-mail when an offer is available. |
| changeRequest.date | Date | If state is REQUESTED - the date of the request. If state is CONFIRMED - the date the change will happen. |
| changeRequest.feeProduct | Id | Id of product for fee for change. |
| changeRequest.monthlyCost | Number | Monthly fee cost (FIBER only). |
| changeRequest.monthlyWholesale | Number | Monthly fee reseller (FIBER only). |
| changeRequest.monthlyCustomer | Number | Monthly fee customer (FIBER only). |
Example
{ state: 'REQUESTED', product: '1234567890123457890ABCD', by: '1234578901234567890FEDE', date: '2018-01-01T00:00:00.000Z', feeProduct: null, monthlyCost: null, monthlyWholesale: null, monthlyCustomer: null }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | not_found | Internet account not found |
| 409 | type | Changes only possible for DSL type |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/internet/account/change-request.txt · Last modified: 2018/09/28 10:38 by Per Møller