Class ZonesApiV2Controller

Class ZonesApiV2Controller

Provides a gateway to the CountryService which handles the shop zone resources.

AbstractApiV2Controller

Extended by

HttpApiV2Controller

Extended by

ZonesApiV2Controller

Package: ApiV2Controllers
Category: System
Located at Controllers/Api/v2/ZonesApiV2Controller.inc.php

Methods summary

`public`	# `__initialize( )` Initialize Controller Initialize Controller
`public`	# `get( )` Api {get} /zones/:id Get Zones Apidescription Get a single registered zone resource. This method is currently limited to only fetching a single zone and might be updated in a future version of the API. Apierror (Error 5xx) 501-NotImplemented If the ID is not included in the request URI then the API will return a 501 error status because it cannot return all the registered countries. Apiexample {curl} Get Zone With ID = 84 curl --user admin@shop.de:12345 http://shop.de/api.php/v2/zones/84 Apigroup Zones Apiname GetZone Apiparam {int} id (required) The zone record ID to be returned. Apisuccess Response-Body If successful, this method will return the zone resource in JSON format. Apiversion 2.1.0
`public`	# `post( )` POST operation is not supported by the CountryService. POST operation is not supported by the CountryService. Throws `HttpApiV2Exception`
`public`	# `put( )` PUT operation is not supported by the CountryService. PUT operation is not supported by the CountryService. Throws `HttpApiV2Exception`
`public`	# `delete( )` DELETE operation is not supported by the CountryService. DELETE operation is not supported by the CountryService. Throws `HttpApiV2Exception`

Methods inherited from HttpApiV2Controller

_linkResponse(), _locateResource(), _mapResponse(), _minimizeResponse(), _paginateResponse(), _searchResponse(), _setJsonValue(), _sortResponse(), _writeResponse()

Methods inherited from AbstractApiV2Controller

__construct()

Constants summary

Constants inherited from AbstractApiV2Controller

DEFAULT_CONTROLLER_NAME, DEFAULT_PAGE_ITEMS, DEFAULT_RATE_LIMIT, DEFAULT_RATE_RESET_PERIOD

Properties summary

`protected CountryServiceInterface`	`$countryService`	#
`protected ZoneJsonSerializer`	`$zoneSerializer`	#

Properties inherited from AbstractApiV2Controller