Description:

This API is used to check the base URL(where Faveo is installed) is valid or not.

URL :   api/v1/helpdesk/url  

             (Replace this URL with you helpdesk URL)

Parameters:

Name Data Type Required / Optional Description
url String Required Url of the website
api_key String optional Api key

HTTP Method : GET  

  •   URL Request Example:

https://www.stablehelpdesk.faveodemo.com/api/v1/helpdesk/url?url=https://www.stablehelpdesk.faveodemo.com

Response

  •   Response Format: JSON
  •   Returns JSON which contains the result.

Sample JSON Success Response :

{

     "result": "success"

}

Response Description:

Parameter                                                   Description
result It will return success for positive response else it will return fails.

Possible Errors/Failures:

{
   "error": {
       "url": [
           "The url format is invalid."
       ]
   }
}

OR

{

 “result”:”Invalid url”

}

OR

{

   "error": {

       "url": [

           "The url field is required."

       ]

   } }

OR

*Please check the responses for some common errors

Leave a Reply

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