Associating regions with region zones

You can designate that a region includes a set of one or more region zones. A region zone in the base application is a United States state, county, or zip code, or, another international equivalent, such as a province in Canada. For example, in the base application sample data loaded with ClaimCenter, the Los Angeles Claims Center - SoCal region is associated with the following counties in California:

Imperial
Kern
Los Angeles
Orange
Riverside
San Bernadino
San Diego
San Luis Obispo
Santa Barbara
Ventura

Querying for region zone information

You can query for:

All region zones for a specific region:
- GET /admin/v1/regions/{regionId}/region-zones
A specific region zone for a specific region:
- GET /admin/v1/regions/{regionId}/region-zones/{regionZoneId}

For example, the following retrieves all the region zones for the Boise region (ID of demo_sample:7):

Command

GET admin/v1/regions/demo_sample:7/region-zones

Response

{
    "count": 2,
    "data": [
        {
            "attributes": {
                "code": "ID",
                "country": {
                    "code": "US",
                    "name": "United States"
                },
                "id": "demo_sample:62",
                "zoneType": {
                    "code": "state",
                    "name": "State"
                }
            },
            "checksum": "0",
            "links": {
                "self": {
                    "href": "/admin/v1/regions/demo_sample:7/region-zones/demo_sample:62",
                    "methods": [
                        "delete",
                        "get"
                    ]
                }
            }
        },
        {
            "attributes": {
                "code": "MT",
                "country": {
                    "code": "US",
                    "name": "United States"
                },
                "id": "demo_sample:63",
                "zoneType": {
                    "code": "state",
                    "name": "State"
                }
            },
            "checksum": "0",
            "links": {
                "self": {
                    "href": "/admin/v1/regions/demo_sample:7/region-zones/demo_sample:63",
                    "methods": [
                        "delete",
                        "get"
                    ]
                }
            }
        }
    ],
    ...

Associating region zones with a region

You can associate a region zone with a region. For example, you would do this to designate that a region includes a region zone. For this endpoint, the geographic zone endpoint object is included in the request object. In InsuranceSuite applications, the geographic zone contains all the states, counties, and zip code data to populate region zones for regions. To do this, all that is needed is the id of the geographic zone in the request body.

See Geographic zones.

For example, the following request in ClaimCenter associates the Canadian province of British Columbia (BC) (ID of CA:Sez8oN61kEFkb9g6C9uvH) with the Canada region (ID of cc:SEkpCtwD5PA2VYXtmOCNE):

Command

POST admin/v1/regions/cc:SSivbi19APF67brdNHwj0/region-zones

Request

{
  "data": {
    "attributes": {
      "geographicZone": {
        "id": "CA:Sez8oN61kEFkb9g6C9uvH"
      }
    }
  }
}

Response

{
    "data": {
        "attributes": {
            "code": "BC",
            "country": {
                "code": "CA",
                "name": "Canada"
            },
            "id": "cc:SNSkahx9ZJGxoxOg6UAv3",
            "zoneType": {
                "code": "province",
                "name": "Province"
            }
        },
...

Deleting geographic zones for a region

You can delete a region (geographic) zone for a region. In that way, a particular region zone is no longer associated with a particular region.

Use the following endpoint to delete a region zone for a region:

DELETE /admin/v1/regions/{regionId}/region-zones/{regionZoneId}

For example, the following request deletes the region zone with the id of pc:SmLiC47Ujldr1!985WjVfQ in PolicyCenter for the Los Angeles region.

Command

DELETE admin/v1/regions/pc:SSivbi19APF67brdNHwj0/geographic-zones/pc:SmLiC47Ujldr1!985WjVfQ

<no request body>