URL : api/helptopic-list

Method : GET

Query Parameters :

Parameter Type Possible Values Required/Optional Description
sort-field String name Optional Field name to sort
sort-order String asc, desc Optional Sorting order either ascending or descending
search-query String Optional Keyword to be searched in HelpTopic list page
limit Integer Optional Number of records to be displayed in each page
page Integer Optional Page number

Success Response:

{
  "success": true,
  "data": {
    "current_page": 1,
    "first_page_url": "http://localhost/faveo_sd/faveo-helpdesk-advance/public/api/helptopic-list?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://localhost/faveo_sd/faveo-helpdesk-advance/public/api/helptopic-list?page=1",
    "next_page_url": null,
    "path": "http://localhost/faveo_sd/faveo-helpdesk-advance/public/api/helptopic-list",
    "per_page": 10,
    "prev_page_url": null,
    "to": 4,
    "total": 4,
    "helpTopics": [
      {
        "id": 1,
        "topic": "Support query",
        "type": 1,
        "status": 1,
        "updated_at": "2020-08-20 09:25:56",
        "department": {
          "id": 1,
          "name": "Support",
          "form_identifier": "department_1"
        },
        "form_identifier": "help_topic_1"
      },
      {
        "id": 3,
        "topic": "Operational query",
        "type": 0,
        "status": 0,
        "updated_at": "2020-08-20 09:30:10",
        "department": {
          "id": 1,
          "name": "Support",
          "form_identifier": "department_1"
      },
      "form_identifier": "help_topic_3"
    },
    {
      "id": 4,
      "topic": "Testingervgcsdv",
      "type": 1,
      "status": 1,
      "updated_at": "2020-08-25 06:56:38",
      "department": {
        "id": 1, 
        "name": "Support",
        "form_identifier": "department_1"
      },
      "form_identifier": "help_topic_4"
    },
    ]
  }
}

Leave a Reply

Your email address will not be published. Required fields are marked *