api:mvno:account:roamingpluslog
Table of Contents
API : MVNO Roaming+ log
Introduction
This request will return roaming+ log (TDC network only).
The usage data contains:
- Voice usage
- Data usage
- SMS usage
- MMS usage
- Overcharged SMS (only in JSON response)
The data is always returned for one or more whole months. If from and/or to dates are given, only the year and month part is used.
Request
| URL | https://api.telecomx.dk/mvno/ACCOUNT_ID/roamingpluslog | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. RESELLER_ADMIN ADMIN. |
|
| Param | ACCOUNT_ID | Id of the MVNO account (24 hex-char string). |
| Query | fromDate | First month to return usage data for. Date format: yyyy-mm-dd. Only year and month is used. |
| toDate | Last month to return usage data for. Date format: yyyy-mm-dd. Only year and month is used. | |
Query example
https://api.telecomx.dk/mvno/1234567890ABCDEF12345678/roamingpluslog?fromDate=2014-07-01&toDate=2014-08-31
Response
| JSON object | ||
|---|---|---|
| data | Array | List of data. |
| data[].date | Date | The date (month) these data belongs to. |
| data[].restOfWorldChangeLog | Array | Data regarding “Rest-of-World” activations in the given month according to the date above. |
| data[].restOfWorldChangeLog[].type | Enum | Type of change - allowed values are: 'CHANGE', 'ACTIVATION', 'REVERSION'. CHANGE is when a user has bought a new RoW-SOC ACTIVATION is when the RoW-SOC is activated when roaming, both for initial activation and rebuying it REVERSION is when the SOC expires, and is changed back to the SOC in the rate plan. CHANGE_RATEPLAN The rate plan has been changed mid-month, and the customer has thus paid for a new rate plan. This means that if the new rate plan has an included auto-start RoW package, then the next activation will be included. |
| data[].restOfWorldChangeLog[].soc | Object | SOC object, with the relevant SOC. Null when there is no relevant SOC to show, e.g reverting back to not having a SOC. This property will be the SOC that the MVNO account has at this given time, after the change. |
| data[].restOfWorldChangeLog[].soc._id | String | SOC name |
| data[].restOfWorldChangeLog[].soc.description | String | Short description of the SOC |
| data[].restOfWorldChangeLog[].soc.rowType | Enum | 'AUTOSTART' or 'PURCHASE' |
| data[].restOfWorldChangeLog[].cost | Number | The cost of the activation. Only used when type = ACTIVATION |
| data[].restOfWorldChangeLog[].wholesale | Number | The wholesale price of the soc pr month. Only used when type = ACTIVATION |
| data[].restOfWorldChangeLog[].price | Number | The customer price of the soc pr month. Only used when type = ACTIVATION |
| data[].restOfWorldChangeLog[].when | Date | Time of creation of this changelog. If type = ACTIVATION, then this is the time of activation. |
| data[].restOfWorldChangeLog[].expiresAt | Date | When the ROW-activation expires. Only used when type = ACTIVATION |
| data[].restOfWorldChangeLog[].isIncluded | Boolean | Whether this ROW-activation was included in the phone plan or not - if it is included, then it is free (price and wholesale will also be 0) |
Example (if type=JSON)
{ data: [ { date: '2026-01-01T00:00:00.000Z', restOfWorldChangeLog: [ { type: 'ACTIVATION', soc: { _id: 'ABCDEFG', description: 'Roaming Soc - 1 gb autostart', rowType: 'AUTOSTART' }, cost: 5, wholesale: 10, price: 15, when: '2024-06-15T10:00:00.000Z', expiresAt: '2024-07-15T10:00:00.000Z', isIncluded: false }, { ... } ] }, { ... } ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | MVNO account id not found in request URI |
| 404 | sipAccount | MVNO account not found |
| 403 | access_denied | Insufficient access level |
| 422 | toDate | To date is before from date |
| 409 | toDate | The date span is too large |
api/mvno/account/roamingpluslog.txt · Last modified: by Per Møller