MobileApp

Perform Template Action

Changed on

Function: perform_template_action Type: API Endpoint (POST)

Purpose:
This endpoint performs various actions on a template page based on the provided request data.

Request Parameters:

  • request (Request): The request object.
  • action_data (TemplateActionRequest): An object containing details about the action to be performed.
  • Customer_Key (Header, required): A base64 encoded string containing lscode and firmcode.
  • User_Code (Header, required): The user code of the user performing the action.
  • current_user (str): The current user performing the operation, obtained via dependency injection.
  • db (Session): The database session, obtained via dependency injection.

Request Body:

  • action_data (TemplateActionRequest): An object containing details about the action to be performed.

Returns:

  • A JSON response indicating the success or failure of the operation.

Exceptions:

  • Handles exceptions related to database operations and invalid customer key formats, providing appropriate error messages.
post/api/MobileApp/templates/perform_action

Request

Headers

Customer-Keystring required
User-Codestring required

Request body

template_codestring required
action_typeinteger required
action_valueboolean nullable

Response

Successful Response

unknown required

Changes