List Services

Pending

GET

https://api.mpc.dev.placewise.com/v1/content/management/pages/services

API Permit:Cms:Api:Management:Pages:Services:List

API Context:Customer

Authorizations:UserToken

Returns list of Services in the system.

Response Body

Key	Type	Optional?	Description
page_services[].name	string	no
page_services[].url_params.available	string[]	no (may be empty)	Names of params available within URL of Page assigned to the service
page_services[].url_params.required	string[]	no (may be empty)	Names of params required within URL of Page assigned to the service
page_services[].mandatory_component	string	no	Name of Component that must exist on Page assigned to this service

Example

When successful, returns object containing services:

{
  "page_services": [
    {
      "name": "article_page",
      "url_params": {
        "available": [
          "id",
          "slug"
        ],
        "required": [
          "id"
        ]
      },
      "mandatory_component": "article_container"
    }
  ]
}

Request

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/content/management/pages/services' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-05-07 15:48:47

Validate Component

List Pages

List Services

Response Body#

Example#

Request

Request samples

Responses

Response Body

Example