NetworkAvailability

Preview

This schema is currently in preview and might change in the future.

We’re excited to hear your feedback and ideas. Please send an email to support@gigs.com to share your thoughts.

Name
object
Type
string
Description
Type of object is always networkAvailability.
Allowed values: networkAvailability
Name
availability
Type
array
Description
A list of availability details for the plans in the project.
Name
plan
Type
string
Description
The unique identifier for the plan.
Optional: This property may not always be included.
Example: "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
Name
provider
Type
string
Description
The ID of the network provider supported by this plan.
Optional: This property may not always be included.
Example: "p11"
Name
technologies
Type
object
Description
The technologies supported by the network provider.
Optional: This property may not always be included.
Example: {"4G":{"strength":"good","minDecibelMilliwatts":-90},"5G":{"strength":"fair","minDecibelMilliwatts":-100}}
Name
location
Type
object
Description
The location for which availability information is provided.
Name
address
Type
NetworkAvailabilityAddress
Status
PREVIEW
Description
The address for which availability information is provided.
Optional: This property may not always be included.
Name
coordinates
Type
NetworkAvailabilityCoordinates
Status
PREVIEW
Description
The coordinates for which availability information is provided.
Optional: This property may not always be included.

Example

{
  "object": "networkAvailability",
  "availability": [
    {
      "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
      "provider": "p11",
      "technologies": {
        "4G": {
          "strength": "good",
          "minDecibelMilliwatts": -90
        },
        "5G": {
          "strength": "fair",
          "minDecibelMilliwatts": -100
        }
      }
    }
  ],
  "location": {
    "address": {
      "city": "New York City",
      "country": "US",
      "line1": "129 West 81st Street",
      "line2": "Apartment 5",
      "postalCode": "10024",
      "state": "NY"
    },
    "coordinates": {
      "latitude": 40.7831,
      "longitude": -73.9712
    }
  }
}