1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 <?php
/* --------------------------------------------------------------
TaxZonesApiV2Controller.inc.php 2017-03-30
Gambio GmbH
http://www.gambio.de
Copyright (c) 2017 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
MainFactory::load_class('HttpApiV2Controller');
/**
* Class TaxZonesApiV2Controller
*
* Provides tax zone information.
*
* @category System
* @package ApiV2Controllers
*/
class TaxZonesApiV2Controller extends HttpApiV2Controller
{
/**
* @api {get} /tax_zones Get Tax Zones
* @apiVersion 2.4.0
* @apiName GetTaxZones
* @apiGroup TaxRates
*
* @apiDescription
* Get all tax zones or a single tax zone.
*
* @apiExample {curl} Get All Tax Zones
* curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/tax_zones
*
* @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": ""
* }
* ]
*
* @apiExample {curl} Get Tax Class With ID = 5
* curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/tax_zones/5
*
* @apiSuccessExample {json} Success-Response
* {
* "id": "5",
* "name": "Steuerzone EU",
* "description": "Steuerzone f\u00fcr die EU"
* }
*
* @apiError 404-NotFound Tax zone record could not be found.
* @apiError 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."
* }
*
* @apiErrorExample Error-Response (Invalid ID)
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "status": "error",
* "message": "Provided tax zone ID is invalid, integer expected."
* }
*/
public function get()
{
if(!isset($this->uri[1]))
{
$db = StaticGXCoreLoader::getDatabaseQueryBuilder();
$result = $db->select(['geo_zone_id', 'geo_zone_name', 'geo_zone_description'])
->order_by('geo_zone_id')
->get('geo_zones');
$taxClasses = [];
foreach($result->result_array() as $taxClass)
{
$taxClasses[] = [
'id' => $taxClass['geo_zone_id'],
'name' => $taxClass['geo_zone_name'],
'description' => $taxClass['geo_zone_description']
];
}
}
elseif(!is_numeric($this->uri[1]))
{
throw new HttpApiV2Exception('Provided tax zone ID is invalid, integer expected: ' . gettype($this->uri[1]),
400);
}
else
{
$db = StaticGXCoreLoader::getDatabaseQueryBuilder();
$result = $db->select(['geo_zone_id', 'geo_zone_name', 'geo_zone_description'])
->where('geo_zone_id', (int)$this->uri[1])
->get('geo_zones');
if($result->num_rows())
{
$taxClass = $result->row_array();
$taxClasses = [
'id' => $taxClass['geo_zone_id'],
'name' => $taxClass['geo_zone_name'],
'description' => $taxClass['geo_zone_description']
];
}
else
{
throw new HttpApiV2Exception('Tax zone record could not be found.', 404);
}
}
$this->_writeResponse($taxClasses);
}
}