Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
  1. Common Concepts
  • Introduction
  • Global Headers
  • Common HTTP Error Codes
  • API Permits
  • Rate Limiting
  • Authorization
    • Token Authorization
    • Member Authorization
    • User Authorization
  • API Contexts
    • Customer Context
    • LoyaltyClub Context
    • Global Context
  • Common Concepts
    • Localization
    • System URLs
    • Params Validation
    • Pagination
    • Sorting
  • Common Models
    • Common Data Formats
    • Member Model
    • API Entity Model
    • Opening Hours Model
  1. Common Concepts

System URLs

Some API entities (e.g. CMS Page Components allow to define a relation to another entity according to internal URL schemes.
Defining the relation this way establishes a permalink - actual URL is generated on the fly (for example, when presenting the content to end users) according to current configuration.

URL Schemes List#

URL SchemeDescription
website://page{?id}Website Page
website://article{?id,slug}Website Article
website://event{?id,slug}Website Event
website://job{?id,slug}Website Job
website://store{?id,slug}Website Store
website://promotion{?id}Website Promotion
website://service_page?service=home_pageWebsite Home Page
website://service_page?service=articles_listWebsite Articles List
website://service_page?service=events_listWebsite Events List
website://service_page?service=jobs_listWebsite Jobs List
website://service_page?service=stores_listWebsite Stores List
website://service_page?service=promotions_listWebsite Promotions List

Website Page#

website://page{?id}
Example: website://page?=5

Example output: welcome
Returns URL configured for this Page.

Website entities#

Article#

website://article{?id,slug}
Example: website://article?id=5&slug=awesome

Example output: articles/5-awesome
Returns URL configured for Page
labeled with article_page Service,
identified by ID and, optionally, by slug.

Event#

website://event{?id,slug}
Example: website://event?id=5&slug=awesome
Returns URL configured for Page
labeled with event_page Service,
identified by ID and, optionally, by slug.
Example output: events/5-awesome.

Job Posting#

website://job{?id,slug}
Example: website://job?id=5&slug=awesome

Example output: jobs/5-awesome
Returns URL configured for Page
labeled with job_page Service,
identified by ID and, optionally, by slug.

Store#

website://store{?id,slug}
Example: website://store?id=5&slug=awesome

Example output: stores/5-awesome
Returns URL configured for Page
labeled with store_page Service,
identified by ID and, optionally, by slug.

Promotion#

website://promotion{?id}
Example: website://promotion?id=5

Example output: promotions/5
Returns URL configured for Page
labeled with promotion_page Service,
identified by ID and slug (for decoration).

Website Service Pages#

Home Page#

website://service_pages?service=home_page
Example output: home
Returns URL configured for Page
labeled with home_page Service

Articles List#

website://service_pages?service=articles_list
Example output: articles
Returns URL configured for Page
labeled with articles_list Service

Events List#

website://service_pages?service=events_list
Example output: events
Returns URL configured for Page
labeled with events_list Service

Jobs List#

website://service_pages?service=jobs_list
Example output: jobs
Returns URL configured for Page
labeled with jobs_list Service

Stores List#

website://service_pages?service=stores_list
Example output: stores
Returns URL configured for Page
labeled with stores_list Service

Promotions List#

website://service_pages?service=promotions_list
Example output: promotions
Returns URL configured for Page
labeled with promotions_list Service
Previous
Localization
Next
Params Validation
Built with