Modify Customer Zone

This API is used to modify a single user-defined zone.

HTTP URL
PUT	/api/v2/customer/{id}/zone/{id

Eligibility

The Requester is eligible to request to modify its own user-defined zones. The Requester is not allowed to request to modify any other customer zone.

API Request

Request Structure

Element	Type	M/O/CM	Description
name	String	M	Customer’s (user-defined) zone name
description	String	O	Customer’s (user-defined) zone description.
countryCode	String	M	ISO alpha-3 Country Code
plmn	String	M	Public Land Mobile Network. MCCMNC representation

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
requestId	UUID	M	Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed

Element

Type

M/O/CM

Description

requestId

UUID

Request instance ID.

To be used by external systems to query the call (operation) status:

In progress
Successful
Failed

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
CUSTOMER_1002	Customer does not exist
CUSTOMER_1029	Failed to update customer zone

Examples

Request Body

Copy

{
  "name": "Canada North",
  "description": "Canada north regions",
  "countryCode": "CAN",
  "plmn": [
    "CANTS",
    "CANIW"
  ]
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

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