Class TaxZonesApiV2Controller

Class TaxZonesApiV2Controller

Provides tax zone information.

AbstractApiV2Controller

Extended by

HttpApiV2Controller

Extended by

TaxZonesApiV2Controller

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

Methods summary

`public`	# `get( )` Api {get} /tax_zones Get Tax Zones Apidescription Get all tax zones or a single tax zone. Apierror 404-NotFound Tax zone record could not be found. 400-BadRequest Invalid rax class id provided (expected integer). Apierrorexample Error-Response (Tax Class Not Found) HTTP/1.1 404 Not Found { "code": 404, "status": "error", "message": "Tax zone record could not be found." } Error-Response (Invalid ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Provided tax zone ID is invalid, integer expected." } Apiexample {curl} Get All Tax Zones curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/tax_zones {curl} Get Tax Class With ID = 5 curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/tax_zones/5 Apigroup TaxRates Apiname GetTaxZones Apisuccessexample {json} Success-Response [ { "id": "5", "name": "Steuerzone EU", "description": "Steuerzone f\u00fcr die EU" }, { "id": "6", "name": "Steuerzone EU-Ausland", "description": "" }, { "id": "7", "name": "Steuerzone B2B", "description": "" }, { "id": "8", "name": "Belgien", "description": "" }, { "id": "9", "name": "Bulgarien", "description": "" }, { "id": "10", "name": "D\u00e4nemark", "description": "" }, { "id": "11", "name": "Deutschland", "description": "" }, { "id": "12", "name": "\u00d6sterreich", "description": "" }, { "id": "13", "name": "Estland", "description": "" }, { "id": "14", "name": "Finnland", "description": "" }, { "id": "15", "name": "Frankreich", "description": "" }, { "id": "16", "name": "Griechenland", "description": "" }, { "id": "17", "name": "Irland", "description": "" }, { "id": "18", "name": "Italien", "description": "" }, { "id": "19", "name": "Kroatien", "description": "" }, { "id": "20", "name": "Lettland", "description": "" }, { "id": "21", "name": "Litauen", "description": "" }, { "id": "22", "name": "Luxemburg", "description": "" }, { "id": "23", "name": "Malta", "description": "" }, { "id": "24", "name": "Niederlande", "description": "" }, { "id": "25", "name": "Polen", "description": "" }, { "id": "26", "name": "Portugal", "description": "" }, { "id": "27", "name": "Rum\u00e4nien", "description": "" }, { "id": "28", "name": "Schweden", "description": "" }, { "id": "29", "name": "Slowakei", "description": "" }, { "id": "30", "name": "Slowenien", "description": "" }, { "id": "31", "name": "Spanien", "description": "" }, { "id": "32", "name": "Tschechien", "description": "" }, { "id": "33", "name": "Ungarn", "description": "" }, { "id": "34", "name": "Vereinigtes K\u00f6nigreich", "description": "" }, { "id": "35", "name": "Zypern", "description": "" } ] {json} Success-Response { "id": "5", "name": "Steuerzone EU", "description": "Steuerzone f\u00fcr die EU" } Apiversion 2.4.0

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

Properties inherited from AbstractApiV2Controller