Jump to

• Request
• Response

getPageContext

get

/ccstore/v1/clientApplications/page/{path: .*}

Gets the page context.

Request

Supported Media Types

• application/json

Path Parameters

• path: .*: string
  The page path.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getPageContext_response

Type: object

Show Source

• context(optional): object context
  The page context response
• status(optional): object status
  The status of the response

{
    "properties":{
        "context":{
            "description":"The page context response",
            "type":"object",
            "properties":{
                "symbol":{
                    "description":"The currency symbol.",
                    "type":"string"
                },
                "productionURL":{
                    "description":"Production URL for the site.",
                    "type":"string"
                },
                "baseCatalogId":{
                    "description":"The ID of the base catalog.",
                    "type":"string"
                },
                "displayName":{
                    "description":"The display name of the page.",
                    "type":"string"
                },
                "canonicalRoute":{
                    "description":"The canonical route of the page.",
                    "type":"string"
                },
                "contextId":{
                    "description":"The context ID.",
                    "type":"string"
                },
                "locale":{
                    "description":"The locale of the page.",
                    "type":"string"
                },
                "currentPriceGroupId":{
                    "description":"The ID of the current price group used.",
                    "type":"string"
                },
                "path":{
                    "description":"Path of the page.",
                    "type":"string"
                },
                "pageType":{
                    "description":"The type of the page.",
                    "type":"string"
                },
                "route":{
                    "description":"The route of the page.",
                    "type":"string"
                },
                "catalogId":{
                    "description":"The ID of the default catalog.",
                    "type":"string"
                },
                "siteId":{
                    "description":"The ID of the site for the page.",
                    "type":"string"
                },
                "currencyCode":{
                    "description":"The currency code of the page.",
                    "type":"string"
                }
            }
        },
        "status":{
            "description":"The status of the response",
            "type":"object",
            "properties":{
                "status":{
                    "description":"The status code of the response",
                    "type":"integer"
                }
            }
        }
    }
}

Nested Schema : context

Type: object

The page context response

Show Source

• baseCatalogId(optional): string
  The ID of the base catalog.
• canonicalRoute(optional): string
  The canonical route of the page.
• catalogId(optional): string
  The ID of the default catalog.
• 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.

{
    "description":"The page context response",
    "type":"object",
    "properties":{
        "symbol":{
            "description":"The currency symbol.",
            "type":"string"
        },
        "productionURL":{
            "description":"Production URL for the site.",
            "type":"string"
        },
        "baseCatalogId":{
            "description":"The ID of the base catalog.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of the page.",
            "type":"string"
        },
        "canonicalRoute":{
            "description":"The canonical route of the page.",
            "type":"string"
        },
        "contextId":{
            "description":"The context ID.",
            "type":"string"
        },
        "locale":{
            "description":"The locale of the page.",
            "type":"string"
        },
        "currentPriceGroupId":{
            "description":"The ID of the current price group used.",
            "type":"string"
        },
        "path":{
            "description":"Path of the page.",
            "type":"string"
        },
        "pageType":{
            "description":"The type of the page.",
            "type":"string"
        },
        "route":{
            "description":"The route of the page.",
            "type":"string"
        },
        "catalogId":{
            "description":"The ID of the default catalog.",
            "type":"string"
        },
        "siteId":{
            "description":"The ID of the site for the page.",
            "type":"string"
        },
        "currencyCode":{
            "description":"The currency code of the page.",
            "type":"string"
        }
    }
}

Nested Schema : status

Type: object

The status of the response

Show Source

• status(optional): integer
  The status code of the response

{
    "description":"The status of the response",
    "type":"object",
    "properties":{
        "status":{
            "description":"The status code of the response",
            "type":"integer"
        }
    }
}

Example Response (application/json)

{
    "context":{
        "symbol":"$",
        "productionURL":null,
        "baseCatalogId":null,
        "displayName":"Home",
        "canonicalRoute":"/en_GB",
        "contextId":null,
        "locale":"en",
        "currentPriceGroupId":"defaultPriceGroup",
        "path":"home",
        "pageType":"home",
        "route":"/home",
        "catalogId":"cloudCatalog",
        "siteId":"siteUS",
        "currencyCode":"USD"
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccstore/v1/clientApplications/page/home"
        }
    ],
    "status":{
        "status":200
    }
}

Default Response

The error response.

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top