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

Journey



CREATE

Use POST method to create new subordinate resources.

Example request URIs

[POST] https://{{kiwire_ip}}/api/journey/ 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
journey_name string The name of the journey.
page_list integer Page id that is link with the journey.
created_by string The one who create the jouney
created_when datetime The created date
status y or n Status of the journey whether enable or disable.
lang string Choose the language either English, Chinese or Malay.
pre_login string Pre login behavior for user prior to the login journey.
pre_login_url string Url to redirect for pre login
post_login string Post login behavior for user experience after they have successfully login to the network.
post_login_url string Url to redirect for post login



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/journey/{{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
journey_name string The name of the journey.
page_list integer Page id that is link with the journey.
created_by string The one who create the jouney
created_when datetime The created date
status y or n Status of the journey whether enable or disable.
lang string Choose the language either English, Chinese or Malay.
pre_login string Pre login behavior for user prior to the login journey.
pre_login_url string Url to redirect for pre login
post_login string Post login behavior for user experience after they have successfully login to the network.
post_login_url string Url to redirect for post login



DELETE

Use DELETE method as the name applies to delete resources.

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/journey/{{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/journey/ [GET] https://{{kiwire_ip}}/api/journey/{{id}}/ [GET] https://{{kiwire_ip}}/api/journey/{{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/journey/0/10/id/desc/