Class CountriesApiV2Controller

Class CountriesApiV2Controller

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

AbstractApiV2Controller

Extended by

HttpApiV2Controller

Extended by

CountriesApiV2Controller

Package: ApiV2Controllers
Category: System
Located at v2/CountriesApiV2Controller.inc.php

Methods summary

`public`	# `__initialize( )` Initialize Controller Initialize Controller
`public`	# `get( )` Api {get} /countries/:id Get Countries Apidescription Get a single country or a specific country's zones. This method is currently limited to only fetching a single country resource so make sure that you provide the country ID in the request URI. Apierror (Error 5xx) 500-InternalError If the record is not found or something else goes wrong the API will return a 500 error status. Read the message for more info. (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 Country With ID = 81 curl --user admin@shop.de:12345 http://shop.de/api.php/v2/countries/81 {curl} Get Zones of Country with ID = 81 curl --user admin@shop.de:12345 http://shop.de/api.php/v2/countries/81/zones Apigroup Countries Apiname GetCountry Apisuccess Response-Body If successful, this method will return the country resource in JSON format. Apiversion 2.1.0
`protected`	# `_getCountryZones( )` Sub Resource for the country zones. Sub Resource for the country zones. The API consumer can easily get the zones that are related with a specific country.

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 CountryJsonSerializer`	`$countrySerializer`	#

Properties inherited from AbstractApiV2Controller