SPS - Network Management
Documentation Powered by Redocly

SPS - Network Management (v5)

Download OpenAPI specification:Download

The "Network Management" API provides capabilities such as network selector, network coverage check.

Operations

Provides the capability to check network coverage based on a location

This API allows to check network coverage based on address or location latitide and longitude

path Parameters
lookup
required
string
Enum: "byAddress" "byLocation"
Example: byAddress

Look-up

query Parameters
addressLine1
string [ 1 .. 50 ] characters ^[ \S]+$
Example: addressLine1=8080 Eden Road

address/street number details of the subscriber

addressLine2
string [ 1 .. 50 ] characters ^[ \S]+$
Example: addressLine2=Apt#1090

suite number of the subscriber

city
string [ 1 .. 64 ] characters ^[ \S]+$
Example: city=Eden Prairie

City of the Subscriber

state
string [ 1 .. 32 ] characters
Example: state=Minnesota

State

zipcode
string 5 characters [0-9]
Example: zipcode=55344

zipcode ** Required when using Lookup byAddress

latitude
number <float> [ -90 .. 90 ]
Example: latitude=–90.000000

Latitude ** Required when using Lookup byLocation

longitude
number <float> [ -180 .. 180 ]
Example: longitude=–180.000000

Longitude ** Required when using Lookup byLocation.

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 920000108464

Identifier of wholesale customer/partner

Responses

Response samples

Content type
application/json
{
  • "coverageAvailability": "Yes",
  • "serviceLevel": [
    ]
}

Provides the capability to reset the voicemail password for the given subscription

This method provides the capability to reset the voicemail password for the given subscription

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 920000108464

Identifier of wholesale customer/partner

Request Body schema: application/json

This represents the model of request payload for reset voice mail password

gpsi
required
string [ 11 .. 15 ] characters ^[0-9]{11,15}$

GPSI

Responses

Request samples

Content type
application/json
{
  • "gpsi": "1234567890"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}