getPageContext
get
/ccstore/v1/clientApplications/page/{path: .*}
Gets the page context.
Request
Supported Media Types
- application/json
Path Parameters
-
path: .*: string
The page path.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getPageContext_response
Type:
Show Source
object
-
context(optional):
object context
The page context response
-
status(optional):
object status
The status of the response
Nested Schema : context
Type:
object
The page context response
Show Source
-
canonicalRoute(optional):
string
The canonical route of the page.
-
contextId(optional):
string
The context ID.
-
currencyCode(optional):
string
The currency code of the page.
-
currentPriceGroupId(optional):
string
The ID of the current price group used.
-
displayName(optional):
string
The display name of the page.
-
locale(optional):
string
The locale of the page.
-
pageType(optional):
string
The type of the page.
-
path(optional):
string
Path of the page.
-
productionURL(optional):
string
Production URL for the site.
-
route(optional):
string
The route of the page.
-
siteId(optional):
string
The ID of the site for the page.
-
symbol(optional):
string
The currency symbol.
Nested Schema : status
Type:
object
The status of the response
Show Source
-
status(optional):
integer
The status code of the response
Example Response (application/json)
{
"context":{
"path":"home",
"symbol":"$",
"pageType":"home",
"route":"/home",
"productionURL":null,
"displayName":"Home",
"canonicalRoute":"/en_GB",
"siteId":"siteUS",
"contextId":null,
"locale":"en",
"currencyCode":"USD",
"currentPriceGroupId":"defaultPriceGroup"
},
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccstore/v1/clientApplications/page/home"
}
],
"status":{
"status":200
}
}
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