Get System Zones

This API is used to retrieve a list of all system zones that exist in the system and are available for use.

HTTP URL
GET	/api/v2/global/zone

API Request

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	System zone’s universal unique identity
name	String	M	System zone name
description	String	O	System zone description
countryCode	String	M	ISO alpha-3 Country Code

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": "2a26048b-1ed4-6d74-b094-c7d26522012c",
      "name": "United States",
      "description": "System zone - USA",
      "countryCode": "USA"
    },
    {
      "id": "1b15048b-1ed4-4d34-a074-c7e26520e12a",
      "name": "Canada",
      "description": "System zone - Canada",
      "countryCode": "CAN"
    },
    {
      "id": "40007bac-a0bc-4e43-a955-1207e7d546dd",
      "name": "United Kingdom",
      "description": "System zone - United Kingdom",
      "countryCode": "GBR"
    }
  ],
  "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": ""
}