Bookmarklist

Function: Bookmark List
Type: API Endpoint (GET)

Purpose:
This function retrieves a list of bookmarks or fetch specific bookmark associated with a specific user and report. The bookmarks are returned in JSON format and can be used to manage user preferences or quick access links.

Usage:
This API is used to fetch bookmarks for a particular user concerning a specific report. The user and report codes must be URL-encoded to ensure proper transmission of data.

Endpoint:
GET http://<baseURL>/api/MobileApp/Bookmarks?action=<action>&user=<Encoded User Code>&report=<Encoded Report Code>

Headers:

• Customer-Key: Required. An encoded string containing the LSCode and FirmCode, separated by a pipe (|).

Query Parameters

• action (string, required): 0 for list and 1 for fetch.
• user (string, required): The encoded user code for which bookmarks are being retrieved.
• report (string, required): The encoded report code related to the bookmarks.

Request Example:

GET /api/MobileApp/Bookmarks?action=<action>&user=Encoded User Code&report=Encoded Report Code
Headers:
Customer-Key: Encoded LSCode|Encoded FirmCode

Response:
A JSON object containing a list of bookmarks associated with the specified user and report.

Response Example:

{
    "bookmarksList": [
        {
            "bookmark_id": "<"Bookmark Id">",
            "bookmark_name": "<"Bookmark Name">",
            "bookmark_state": "<"bookmark state">",
            "is_default": null
        },
        ...
    ]
}

Notes:

• The bookmark_id is a unique identifier for each bookmark.
• The bookmark_name indicates the display name of the bookmark.
• The bookmark_state may contain additional state information related to the bookmark.
• The is_default field indicates whether the bookmark is a default bookmark (may return null if not applicable).

Error Handling:
If the request fails (e.g., due to invalid parameters or authentication issues), an appropriate error response will be returned.

Example Error Response:

{
    "status": "failed",
    "message": "Invalid user code or report code"
}

Important:
Ensure that the user code and report code are properly encoded to prevent issues with special characters in the URL.