getResourceBundle
get
/ccstore/v1/resources/{bundle}
Get Resource Bundle. Fetch the specified resource bundle for the specified locale
Request
Supported Media Types
- application/json
Path Parameters
-
bundle: string
The name of the resource bundle to get.
Query Parameters
-
locale: string
The locale to retrieve the resources for
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getResourceBundle_response
Type:
Show Source
object
-
resources(optional):
object resources
Response object containing resource bundle information for the specified locale
Nested Schema : resources
Type:
object
Response object containing resource bundle information for the specified locale
Show Source
-
sampleKey(optional):
string
Value of sampleKey
Example Response (application/json)
{
"resources":{
"categoryNavAll":"All __categoryName__",
"productNameHasNext":"__productName__, ",
"emailAddressText":"Email Address",
"headercreateNewPassword":"Create New Password",
"productresultsText":"Results: __startIndex__ - __endIndex__ (of __totalProducts__)",
"noproductsfound":"You searched for '__searchterm__'. No products were found.",
"optionHasNext":"$t(ns.common:resources.option),",
"createNewPwdMessage":"Password successfully updated.",
"orderCouponDisplayText":"* __description__ - __code__",
"cartDropDownText_plural":"__count__ items - __currency____totalPrice__",
"productPriceChanged":"This item's price has changed since it was added to your cart. Original price was: __currency____originalPrice__ ",
"invalidOrderDetails":"There has been an error. Please check the shipping address",
"decemberText":"December",
"lastNameText":"Last Name",
"lastNameRequired":"Last Name is mandatory. ",
"estimatedCost":"est: __currency____cost__",
"emptyProductresultsText":"Results: 0",
"categoryText":"Category",
"maxlengthValidationMsg":"Invalid entry __fieldName__. Please do not exceed the maximum of __maxLength__ characters.",
"removeItemMsg":"Remove item from your cart?",
"octoberText":"October",
"searchresultsText":"Results: __startIndex__ - __endIndex__ (of __count__)",
"quantityText":"Quantity",
"sharedWidget":"(shared)",
"embeddedAssistanceMinPasswordLengthText":"is at least __min__ characters long",
"emailPasswordText":"Email Password",
"escapeKeyText":"esc",
"searchFailedText":"Unable to perform a search at this time.",
"embeddedAssistancePreText":"You must ensure your password:",
"newPasswdText":"New Password",
"maxLengthEmailAdd":"Invalid entry. Please do not exceed the maximum of __maxLength__ characters",
"passwordRequired":"Password is mandatory. ",
"firstNameText":"First Name",
"searchText":"Showing Results for __searchTerm__ ",
"insufficientStockMsg":"You can order a maximum of __stockLimit__ for this product.",
"cancelText":"Cancel",
"subtotalText":"Sub-Total:",
"cartDropDownText":"__count__ item - __currency____totalPrice__",
"fieldsInErrorMsg":"Some fields are in error",
"quantityNumericMsg":"Invalid entry. Please enter only numbers.",
"okText":"OK",
"novemberText":"November",
"forgotPwdPart2":"You must update this the next time you login.",
"continueText":"Continue",
"confirmPasswordRequired":"Please enter your password again. ",
"forgotPwdPart1":"Enter your email address to receive your new temporary password.",
"passwordPoliciesErrorText":"The password entered does not comply with the password policy. Please try again.",
"augustText":"August",
"embeddedAssistanceCannotUseUsernameText":"differs from your username",
"mayText":"May",
"juneText":"June",
"noProductsFound":"You searched for '__searchterm__'. No products were found.",
"productOrderlimitMsg":"Product has an order limit of __orderLimit__.",
"optionCaption":"Select __optionName__ ...",
"optionLast":"$t(ns.common:resources.option)",
"buttonCancel":"Cancel",
"closeText":"Close",
"loginError":"Login unsuccessful. The details entered don't match our records, please try again.",
"itemTotalText":"Item Total",
"currentPasswordText":"Current Password",
"outOfStockMsg":"This item is no longer in stock. Remove item from your cart?",
"orderSubmissionFailed":"Order submission failed.",
"priceRangeText":"Price Range",
"septemberText":"September",
"buttonSave":"Save",
"emailAddressRequired":"Email Address is mandatory. ",
"searchresultsText_plural":"You searched for '__searchterm__'. Results: __startIndex__ - __endIndex__ (of __count__)",
"customTextNotFound":"[Custom Text Missing]",
"forgotPwdText":"Forgotten Password",
"createNewPasswordError":"Your password has expired. Please update before logging in.",
"forgotPasswordLinkText":"Forgotten Password?",
"productTitleText":"Products",
"optionRequiredMsg":"__optionName__ required",
"loadingText":"Loading...",
"emailAddressInvalid":"Invalid entry. Please enter valid email address, for example, john@example.com.",
"newConfirmPasswordText":"Confirm New Password",
"firstNameRequired":"First Name is mandatory. ",
"separator":",",
"resetPwdText":"Reset Password",
"OrderDiscountDesc":"* __discountDesc__",
"successText":"Success",
"embeddedAssistanceUseMixedCase":"contains upper and lower case characters",
"embeddedAssistanceNotInPreviousNPasswords":"has not been previously used",
"oldPasswordsDoNotMatch":"Incorrect value for previous password.",
"warningText":"Warning",
"option":"__optionName__: __optionValue__",
"goToPreviousPagePaginationSymbol":"<", "removecouponlinkreadtext":"remove coupon", "passwordunmatched":"the passwords entered do not match, please try again. ", "gotolastpagepaginationsymbol":">>",
"embeddedAssistanceUseNumber":"includes a number",
"forgotPwdMessage":"A new temporary password has been sent to your email address, along with reset password instructions.",
"goToNextPagePaginationSymbol":">",
"itemText":"Item",
"orderPricingPromotionError":"Please review your order. Items, or discounts applied, have changed since they were added to your order.",
"discountText":"Discount(s)*:",
"previewMessage":"This is your Storefront in the Preview Environment. It is not your Live site.",
"goToFirstPagePaginationSymbol":"<<", "currentpasswordrequired":"current password is mandatory.", "januarytext":"january", "marchtext":"march", "informationtext":"information", "embeddedassistanceusesymbol":"includes a symbol character", "emailcanceltext":"cancel", "searchtitletext":"search", "updatesuccessmsg":"update successfully saved.", "searchheadertext":"search results", "cartsessionexpired":"your session has expired due to inactivity. please login again", "quantityrequiremsg":"quantity mandatory. ", "apriltext":"april", "errortext":"error", "quicksearchresultstext":"quick search results for '__searchtext__'", "julytext":"july", "coupondisplaytext":"__description__ - __code__", "invalidcartitemserror":"__productnames__ currently unavailable and removed from your cart.", "februarytext":"february", "nomatchesfound":"no matches found", "showallresultstext":"show all>>",
"noSearchResultsText":"We couldn't find any results for __searchTerm__"
},
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccstoreui/v1/resources/ns.common?locale=en"
}
]
}",>",>
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code