1. Home
  2. Docs
  3. Kiwire ( v3 ) – API
  4. Pages

Pages



CREATE

Use POST method to create new subordinate resources.

Example request URIs

[POST] https://{{kiwire_ip}}/api/pages/ Parameters Required
Parameter Value Description
tenant_id string Tenant ID or Tenant name of the API key
updated_date datetime The last updated date and time
page_name string The name of the page
count_impress y or n Enable or disable count of the page impression.
purpose string Purpose of the page.
content string Content of the page.
remark string Remark of the page
default_page y or n Enable or disable the page. If the page is set as a default page, the default page for NAS that does not define in any zone or journey.
bg_lg string Backround image
bg_md string Backround image
bg_sm string Backround image
bg_css string Background CSS



PATCH

Use PATCH method is to make a partial update on a resource. 

The differences between PATCH and PUT, PUT method also modify a resource entity but PATCH method is used for partially updating an existing resource. PUT should be used if you are entirety replacing a resource.

Example request URIs

[PATCH] https://{{kiwire_ip}}/api/pages/{{id}}/ Parameters Required
Parameter Value Description
tenant_id string Tenant ID or Tenant name of the API key
updated_date datetime The last updated date and time
page_name string The name of the page
count_impress y or n Enable or disable count of the page impression.
purpose string Purpose of the page.
content string Content of the page.
remark string Remark of the page
default_page y or n Enable or disable the page. If the page is set as a default page, the default page for NAS that does not define in any zone or journey.
bg_lg string Backround image
bg_md string Backround image
bg_sm string Backround image
bg_css string Background CSS



delete

Use DELETE method as the name applies to delete resources.

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/pages/{{id}}/


get

Use GET method to retrieve resource information only and not to modify it in any way.

Example request URIs

[GET] https://{{kiwire_ip}}/api/pages/ [GET] https://{{kiwire_ip}}/api/pages/{{id}}/ [GET] https://{{kiwire_ip}}/api/pages/{{offset}}/{{limit}}/{{column}}/{{order}}/
Value Description
offset integer Start data count
limit integer Limit data count
column string Column name
order desc or asc Sort the result set in ascending or descending order.

NOTE:

For GET method, if {{offset}}, {{limit}}, {{column}}, and {{order}} not provided then Kiwire will return default value eg : https://{{kiwire_ip}}/api/pages/0/10/id/desc/