List Services for a Customer

List all services that belong to a customer account

Request

Path Params

groupno

string

required

Group Number. Users will have access only to specific Groups and must pass this ID when accessing any Resources via API.

Example:

123

custno

string

required

Octane Customer Number.

Example:

554433

Query Params

serviceNumber

string

optional

Filter by a specific Phone Number

Example:

0395551234

productType

enum<string>

optional

Filter by Product Type.

Allowed values:

APDOEMCYHVMONNOROTSHVO

Example:

isActive

boolean

optional

Filter for only Active services

Example:

true

isInContract

boolean

optional

Filter only for services that are in contract or out of contract

Example:

true

isBarred

boolean

optional

Filter for services that are barred

Example:

true

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

array of:

custNo

integer

required

Customer Account number that this service belongs to.

lineSeqNo

integer

required

Unique instance identifier of this service under the customer account

parentLineSeqNo

integer

optional

Indicates whether this service has a parent service it's linked to and what that parent service is

phoneNumber

string

required

Unique service identifier for this service

usageType

string

required

Type of service

name

string

optional

Name given to the service

department

string

optional

Department that this service may be under

lineType

enum<string>

optional

Indication of the type of customer this service is for

Allowed values:

agentNo

integer

optional

Agent identifier of the person who sold this service in

dateReleased

string <date-time>

optional

Datetime the service was end dated in the system

dateAdded

string <date-time>

optional

Datetime of when this service was added in the system

userAdded

string

optional

User who added this service in the system

dateModified

string <date-time>

optional

Datetime of when this service was last modified

userModified

string

optional

User who last modified this service

instance

array[object (Service Instance) {12}]

required

Details about the billing instances for this services

serviceid

string

required

Indication of the carrier that this service is under

dateDeclared

string <date-time>

optional

Billing start date for this service

dateProvisioned

string <date-time>

optional

Date that the service was provisioned successfully

dateDisconnected

string <date-time>

optional

Billing end date for this service

provisionStatus

string

optional

Provisioning status of the service, if applicable

status

string

optional

Current billing status for this service

statusExtra

string

optional

Extra details about the billing status for this service

reasonStatusChange

string

optional

Reason for the current status of the service

dateAdded

string <date-time>

optional

Datetime of when this billing instance was added

userAdded

string

optional

User that added this billing instance

dateModified

string <date-time>

optional

Datetime of when this billing instance was last modified

userModified

string

optional

User that last modified this billing instance

serviceAgreement

object (Service Agreement)

required

Details about the agreement that exists for this service, including selected plan and contract term

planNo

integer

optional

Retail Plan ID that should be used to bill this service at the Retail level

retailContractTerm

integer

optional

Retail contract term for this service

retailContractStartDate

string

optional

Retail contract start date

retailContractEndDate

string

optional

Retail contract end date

whsPlanNo

string

optional

Wholesale Plan ID that should be used to bill this service at the Wholesale level

wholesaleContractTerm

integer

optional

Wholesale contract term for this service

wholesaleContractStartDate

string

optional

Wholesale contract start date

wholesaleContractEndDate

string

optional

Wholesale contract end date

voipService

object (Voip Service)

optional

Details relating to Voip services

serviceType

enum<string>

optional

Type of Hosted Voice/Voip Service

Allowed values:

PBXDIDPBXEXTPBXACCTSIPTRUNKSIPTRUNK_LEGACYRESIRESI_LEGACYTEAMSDIRECTUC_THINADVANCED_PBX

pbxId

string

optional

Unique identifier of the PBX

defaultDidPlanNo

integer

optional

Default Plan No to use for the DIDs on this PBX

defaultExtPlanNo

integer

optional

Default Plan No to use for the Extensions on this PBX

extId

integer

optional

Unique Identifier of this Service in External Systems

maxCalls

integer

optional

Max Calls/Channels/Seats configured for a Trunk

packageId

integer

optional

Unique identifier of the Billable Feature Package active on this Service

packageDesc

string

optional

Description of the Billable Feature package

feature

array [object {9}]

optional

dataService

object (Data Service)

optional

Details relating to Data services

username

string

optional

Username this service will use for authentication

password

string

optional

Password this service will use for authentication

ipAddress

string

optional

Static IP address for this service (if IP Type is Static)

ipType

enum<string>

optional

Type of IP provisioned for this service

Allowed values:

StaticDynamic

subnetMask

string

optional

Subnet mask for the service

authenticationType

enum<string>

optional

Type of authentication used by this service

Allowed values:

IPoEPPPoE

networkProfile

string

optional

Speed profile configured for this service on the network side

nbnService

object (NBN Service)

optional

Details relating to NBN services

technologyType

enum<string>

optional

NBN Technology Type

Allowed values:

FTTPHFCFWFTTBFTTNFTTCMixed

avcIdData

string

optional

AVC ID for the UNI-D service

avcIdVoice

string

deprecated

AVC ID for the UNI-V service

portIdData

string

optional

NTD Port ID for the UNI-D service

portIdVoice

string

deprecated

NTD Port ID for the UNI-V service

infrastructureId

string

optional

NTD ID or Copper Pair ID for the service

pri

string

optional

Product Resource Identifier

poi

string

optional

POI that this service is connected to

region

string

optional

Type of Region this service is in

isNfas

boolean

optional

Indicates whether or not this NBN service has undergone upgrade to FTTP.

hasNfasCommitment

boolean

optional

Indicates whether or not this NBN service has a contractual commitment

legacyTechnologyType

string

optional

Indicates the Technology Type this service was on prior to upgrade to FTTP

nfasCommitmentDate

string <date-time>

optional

Indicates the date this Service has a commitment until. NBN Services cancelled prior to this date will be charged an Early Termination Fee by nbnCo

inboundService

object (Inbound Service)

required

Details relating to Inbound Numbers

routingType

enum<string>

optional

The type of Routing configured for this Inbound Number

Allowed values:

SimpleComplex

firstAnswerpoint

string

optional

First answerpoint that is used when this Inbound Number is called.

secondAnswerpoint

string

optional

Second answerpoint that is used when this Inbound Number is called.

finalAnswerpoint

string

optional

Final answerpoint that is used when this Inbound Number is called.

complexRouting

string

optional

Details about the complex routing that is setup for this Inbound Number (if Routing Type is Complex

transferType

string

optional

Indicates the type of transfer that was submitted to bring this Inbound Number across

terminationNumber

string

optional

The Termination Number that is used for this Inbound Number

address

object (Address)

required

Address details for the Service

addressID

string

optional

Address identifier

addressString

string

optional

Full address string

propertyName

string

optional

Name of the property or building

subType

string

optional

Sub Address Type

subNo

string

optional

Sub Address No

streetNoFrom

string

optional

Street No From

streetNoFromSuffix

string

optional

Street No From Suffix

streetNoTo

string

optional

Street No To

streetNoToSuffix

string

optional

Street No To Suffix

streetName

string

required

Street Name

streetType

string

optional

Street Type

streetNameSuffix

string

optional

Street Name Suffix

suburb

string

required

Suburb or locality. Must be a valid Suburb/Locality for the Country.

state

string

required

State. Must be a valid State for the Country selected.

postcode

string

required

Postcode. Must be a valid Postcode for the Country selected.

countryCode

enum<string>

required

Country Code

Allowed value:

contact

object (Service Contact)

optional

Contact Details for this service

contactName

string

optional

Name of the contact person for this service

contactPhone

string

optional

Phone number of the contact person for this service

contactEmail

string <email>

optional

Email address of the contact person for this service

contactDob

string <date>

optional

Date of Birth of the contact person for this service

Example

[
    {
        "custNo": 0,
        "lineSeqNo": 0,
        "parentLineSeqNo": 0,
        "phoneNumber": "string",
        "usageType": "string",
        "name": "string",
        "department": "string",
        "lineType": "B",
        "agentNo": 0,
        "dateReleased": "2019-08-24T14:15:22Z",
        "dateAdded": "2019-08-24T14:15:22Z",
        "userAdded": "string",
        "dateModified": "2019-08-24T14:15:22Z",
        "userModified": "string",
        "instance": [
            {
                "serviceid": "string",
                "dateDeclared": "2019-08-24T14:15:22Z",
                "dateProvisioned": "2019-08-24T14:15:22Z",
                "dateDisconnected": "2019-08-24T14:15:22Z",
                "provisionStatus": "string",
                "status": "string",
                "statusExtra": "string",
                "reasonStatusChange": "string",
                "dateAdded": "2019-08-24T14:15:22Z",
                "userAdded": "string",
                "dateModified": "2019-08-24T14:15:22Z",
                "userModified": "string"
            }
        ],
        "serviceAgreement": {
            "planNo": 0,
            "retailContractTerm": 0,
            "retailContractStartDate": "string",
            "retailContractEndDate": "string",
            "whsPlanNo": "string",
            "wholesaleContractTerm": 0,
            "wholesaleContractStartDate": "string",
            "wholesaleContractEndDate": "string"
        },
        "voipService": {
            "serviceType": "PBXDID",
            "pbxId": "string",
            "defaultDidPlanNo": 0,
            "defaultExtPlanNo": 0,
            "extId": 0,
            "maxCalls": 0,
            "packageId": 0,
            "packageDesc": "string",
            "feature": [
                {
                    "hvId": 0,
                    "featureType": "string",
                    "featureSubType": "string",
                    "dateStart": "2019-08-24T14:15:22Z",
                    "dateEnd": "2019-08-24T14:15:22Z",
                    "dateAdded": "2019-08-24T14:15:22Z",
                    "userAdded": "string",
                    "dateModified": "2019-08-24T14:15:22Z",
                    "userModified": "string"
                }
            ]
        },
        "dataService": {
            "username": "string",
            "password": "string",
            "ipAddress": "string",
            "ipType": "Static",
            "subnetMask": "string",
            "authenticationType": "IPoE",
            "networkProfile": "string"
        },
        "nbnService": {
            "technologyType": "FTTP",
            "avcIdData": "string",
            "avcIdVoice": "string",
            "portIdData": "string",
            "portIdVoice": "string",
            "infrastructureId": "string",
            "pri": "string",
            "poi": "string",
            "region": "string",
            "isNfas": true,
            "hasNfasCommitment": true,
            "legacyTechnologyType": "string",
            "nfasCommitmentDate": "2019-08-24T14:15:22Z"
        },
        "inboundService": {
            "routingType": "Simple",
            "firstAnswerpoint": "string",
            "secondAnswerpoint": "string",
            "finalAnswerpoint": "string",
            "complexRouting": "string",
            "transferType": "string",
            "terminationNumber": "string"
        },
        "address": {
            "addressID": "string",
            "addressString": "string",
            "propertyName": "string",
            "subType": "string",
            "subNo": "string",
            "streetNoFrom": "string",
            "streetNoFromSuffix": "string",
            "streetNoTo": "string",
            "streetNoToSuffix": "string",
            "streetName": "string",
            "streetType": "string",
            "streetNameSuffix": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "countryCode": "AU"
        },
        "contact": {
            "contactName": "string",
            "contactPhone": "string",
            "contactEmail": "user@example.com",
            "contactDob": "2019-08-24"
        }
    }
]

🟠403Invalid access