Get Data Pool - Octane REST API

Get the details of a data pool for a given custno and lineseqno OR a service number.
If all three parameters have inputs, servicenumber will be ignored and the custno-lineseqno service's information will be pulled.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

custno

integer

optional

The Octane Customer Number

Example:

554433

lineseqno

integer

optional

The Octane Line Seq No

Example:

servicenumber

integer

optional

This Octane Service Number

Example:

0650261016 / 61650261016

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

success

boolean

required

Indicator of whether retrieving data for the provided service details was successful

provider

object

optional

serviceNumber

string

required

Phone Number / Service Identifier

dataPoolName

string

optional

The name of the data pool

custno

integer

required

Octane customer account number

lineseqno

integer

required

Service line sequence number

memberId

integer

required

The membership identification number of the service within the pool

dataUsage

string

required

The data that is remaining in the pool

dataMaxCap

string

required

The maximum amount of data within the pool

serviceName

string

required

The service name

ratePlanName

string

required

The name of the rating plan

dataPoolStatus

string

required

The status of the data pool

countAvailable

integer

required

Total number of available spots left in the pool

countConsumers

integer

required

Total number of consumers already in the pool

countMax

integer

required

Max number of consumers that can be in the pool

dataLimit

string

optional

The data limit that has been set on the pool

consumers

array [object {8}]

optional

serviceNumber

string

required

Phone Number / Service Identifier

custno

integer

required

Octane customer account number

lineseqno

integer

required

Service line sequence number

memberId

integer

required

The membership identification number of the service within the pool

ratePlanName

string

required

The name of the rating plan

dataPoolStatus

string

required

The status of the consumer

dataLimit

string

optional

The data limit that has been set on the consumer

serviceName

string

optional

Name of the Service

Examples

SuccessInvalid Service

{
    "success": true,
    "provider": {
        "serviceNumber": "0650261023",
        "dataPoolName": "Testing Pool",
        "custno": 380716,
        "lineseqno": 10,
        "memberId": 7,
        "memberCount": 2,
        "dataUsage": 0,
        "dataMaxCap": 0,
        "serviceName": "",
        "ratePlanName": "Pooling Provider",
        "dataPoolStatus": "Opt In"
    },
    "consumers": [
        {
            "serviceNumber": "0444063876",
            "dataPoolName": "Testing Pool",
            "custno": 380716,
            "lineseqno": 4,
            "memberId": 11,
            "ratePlanName": "MNF Hybrid Plan 3",
            "dataPoolStatus": "Opt In",
            "dataLimit": 0
        },
        {
            "serviceNumber": "0444063948",
            "dataPoolName": "Testing Pool",
            "custno": 380716,
            "lineseqno": 8,
            "memberId": 12,
            "ratePlanName": "MNF Hybrid Plan 1",
            "dataPoolStatus": "Opt In",
            "dataLimit": 0
        }
    ]
}

🟠403Invalid access