Get Customer Availability Zones

This API is used to retrieve a particular customer-defined (user-defined) availability zone, or a list of customer-defined (user-defined) availability zones, created in the system and available for use.

HTTP URL
GET	/api/v2/customer/{id}/availability-zone/{id}

If sent without an Availability Zone ID, the API retrieves a complete list of all availability zones defined by this customer.

Eligibility

The Requester is eligible to request information on customer-defined availability zones that it created by itself for its own plans. The Requester is not eligible to request information on availability zones created at any other customer level, including its own sub-accounts.

API Request

Request Structure

This API has no request structure.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
Id	UUID	M	Customer availability zone’s universal unique identity
name	String	M	Customer's availability zone name
description	String	O	Customer's availability zone description
zone	Object	M	Array of Zone Object

Zone data objects

Element	Type	M/O/CM	Description
Id	Numeric	M	Zone’s universal unique identity (any zone, system or user-defined)
name	String	M	Zone name (any zone, system or user-defined)
countryCode	String	M	ISO alpha-3 Country Code
network	Object	O	Array of Mobile Network object. Empty for a system zone.
isSystem	Boolean	M	Specifies whether the zone is a system zone and cannot be modified or if it is a user-defined zone, which can be modified. True = System Zone False = User-defined (customer) zone

Network data objects

Element	Type	M/O/CM	Description
plmn	String	M	Public Land Mobile Network. MCCMNC representation
mcc	String	M	Mobile Country Code (MCC)
mnc	String	M	Mobile Network Code (MNC)

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again

Examples

Request Body

Copy

{
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "id": "1b15048b-1ed4-4d34-a074-c7e26520e12a",
      "name": "North America 05",
      "description": "All Canadian regions and north USA region",
      "zone": [
        {
          "id": "ff74dca6-8e7f-4b85-a42b-13860913b370",
          "name": "All Canada",
          "countryCode": "CAN",
          "network": [
            {
              "plmn": "CANTS",
              "mcc": "302",
              "mnc": "220"
            },
            {
              "plmn": "CANVT",
              "mcc": "302",
              "mnc": "500"
            }
          ],
          "isSystem": false
        },
        {
          "id": "ceb892d2-f24b-4007-bf81-999fe75cb635",
          "name": "North USA",
          "countryCode": "USA",
          "network": [
            {
              "plmn": "USAW6",
              "mcc": "310",
              "mnc": "260"
            },
            {
              "plmn": "USAWC",
              "mcc": "310",
              "mnc": "180"
            },
            {
              "plmn": "USACO",
              "mcc": "311",
              "mnc": "40"
            }
          ],
          "isSystem": false
        }
      ]
    },
    {
      "id": "40007bac-a0bc-4e43-a955-1207e7d546dd",
      "name": "United Kingdom - Complete",
      "description": "United Kingdom all regions",
      "zone": [
        {
          "id": "e7fcef24-5c03-41dd-9e33-995b7d6f32b1",
          "name": "United Kingdom - Main Land",
          "countryCode": "GBR",
          "network": [
            {
              "plmn": "GBRCN",
              "mcc": "234",
              "mnc": "10"
            },
            {
              "plmn": "GBRME",
              "mcc": "234",
              "mnc": "30"
            }
          ],
          "isSystem": false
        },
        {
          "id": "1b15048b-1ed4-4d34-a074-c7e26520e12a",
          "name": "United Kingdom - Islands",
          "countryCode": "GBR",
          "network": [
            {
              "plmn": "GBRGT",
              "mcc": "234",
              "mnc": "55"
            },
            {
              "plmn": "AAM26",
              "mcc": "901",
              "mnc": "46"
            }
          ],
          "isSystem": false
        }
      ]
    }
  ],
  "pageable": {
    "page": 1,
    "size": 10,
    "totalPages": 1,
    "totalElements": 2
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "GLOBAL_1001",
  "errorMessage": "Service unavailable. Please try again",
  "content": "",
  "pageable": ""
}