Class AddressFormatsApiV2Controller
Class AddressFormatsApiV2Controller
Provides address format information.
-
AbstractApiV2Controller
-
┗
HttpApiV2Controller
-
┗
AddressFormatsApiV2Controller
Methods summary
public
get( void )
Api
{get} /address_formats Get Address Formats
Apidescription
Get all address formats or a single address format.
Apierror
404-NotFound Tax rate record could not be found.
400-BadRequest Invalid rax rate id provided (expected integer).
Apierrorexample
Error-Response (Address Format Not Found)
HTTP/1.1 404 Not Found
{
"code": 404,
"status": "error",
"message": "Address format record could not be found."
}
Error-Response (Invalid ID)
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "Provided address format ID is invalid, integer expected."
}
Apiexample
{curl} Get All Address Formats
curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/address_formats
{curl} Get Address Format With ID = 1
curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/address_formats/1
Apigroup
AddressFormats
Apiname
GetAddressFormats
Apisuccessexample
{json} Success-Response
[
{
"id": "1",
"format": "$firstname $lastname$cr$streets$cr$city, $postcode$cr$statecomma$country",
"summary": "$city / $country"
},
{
"id": "2",
"format": "$firstname $lastname$cr$streets$cr$city, $state $postcode$cr$country",
"summary": "$city, $state / $country"
},
{
"id": "3",
"format": "$firstname $lastname$cr$streets$cr$city$cr$postcode - $statecomma$country",
"summary": "$state / $country"
},
{
"id": "4",
"format": "$firstname $lastname$cr$streets$cr$city ($postcode)$cr$country",
"summary": "$postcode / $country"
},
{
"id": "5",
"format": "$firstname $lastname$cr$streets$cr$postcode $city$cr$country",
"summary": "$city / $country"
}
]
{json} Success-Response
{
"id": "1",
"format": "$firstname $lastname$cr$streets$cr$city, $postcode$cr$statecomma$country",,
"summary": "$city / $country"
}
Apiversion
2.4.0
_linkResponse(),
_locateResource(),
_mapResponse(),
_minimizeResponse(),
_paginateResponse(),
_searchResponse(),
_setJsonValue(),
_sortResponse(),
_writeResponse()
__construct(),
_prepareResponse(),
_setRateLimitHeader(),
_validateRequest()
Constants summary
DEFAULT_CONTROLLER_NAME,
DEFAULT_PAGE_ITEMS,
DEFAULT_RATE_LIMIT,
DEFAULT_RATE_RESET_PERIOD
Properties summary
$api,
$uri