Recommendations

There is the possibility to recommend the customers a product, a service or just an information in CRM CareCloud based on customer purchasing behavior and many other criteria. All recommendations can be viewed by this resource.

Available methods

All available methods for resource recommendations.

HTTP method Endpoint Description
[badge-blue GET] /recommendations List of all recommendations
[badge-blue GET] /recommendations/{recommendation_id} Detail of a recommendation

Get all recommendations

Get the information as a list of all recommendations.
[badge-blue GET] /recommendations

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
name string Search recommendations by name No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
recommendations Recommendation[] List of recommendations
total_items integer Count of all found recommendations

Example request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/recommendations?count=2
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDJhMDAxWUwMTM0NmMyOWQxNmE4NzI1MWZlMmUyMzZmNWMxMzcwNmI2MDJkMzRmN2Q2Mw

Example response

HTTP/1.1 200 OK
Date: Tue, 20 Oct 2020 13:50:11 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "recommendations": [
      {
        "recommendation_id": "8ad8b2b701199684f1222961d6",
        "name": "Lorem ipsum dolor sit amet",
        "brief_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus bibendum orci suscipit mauris convallis sollicitudin. Morbi tempor bibendum dui quis placerat. Fusce sollicitudin metus a ante laoreet, id ultricies mi malesuada.",
        "detailed_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus bibendum orci suscipit mauris convallis sollicitudin. Morbi tempor bibendum dui quis placerat. Fusce sollicitudin metus a ante laoreet, id ultricies mi malesuada. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus bibendum orci suscipit mauris convallis sollicitudin. Morbi tempor bibendum dui quis placerat. Fusce sollicitudin metus a ante laoreet, id ultricies mi malesuada. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus bibendum orci suscipit mauris convallis sollicitudin. Morbi tempor bibendum dui quis placerat. Fusce sollicitudin metus a ante laoreet, id ultricies mi malesuada. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus bibendum orci suscipit mauris convallis sollicitudin. Morbi tempor bibendum dui quis placerat. Fusce sollicitudin metus a ante laoreet, id ultricies mi malesuada.",
        "content": "<p><i><b><u>Paste Options<\/u><\/b><\/i><\/p><p><u><br><\/u><\/p><p>The paste handler is a <b>built-in extension which attempts<\/b> to filter the content when the user pastes. <br><\/p><p>How the paste handler filters is configurable via specific options.<\/p><p><br><\/p><p><i>Options for paste handling are passed as an object that is a member of the outer options object.<\/i><\/p>",
        "picture_urls": [
          "https:\/<projectURL>\/health_recommendations_pictures\/img_health_recommendations_9"
        ],
        "web_url": "",
        "last_change": "2019-08-23 10:49:35",
        "state": 1
      },
      {
        "recommendation_id": "8adf93742cc9eb5def0d5da105",
        "name": "Health recommendation - a",
        "brief_description": "Duis vitae pharetra mauris, id ornare urna. Ut in volutpat ipsum. Aliquam euismod nibh est. Ut maximus risus id malesuada egestas. Nunc nunc erat, porta id lectus at, semper pulvinar orci.",
        "detailed_description": "Duis vitae pharetra mauris, id ornare urna. Ut in volutpat ipsum. Aliquam euismod nibh est. Ut maximus risus id malesuada egestas. Nunc nunc erat, porta id lectus at, semper pulvinar orci.",
        "content": "<h4>Lorem ipsum dolor sit amet, consectetur adipiscing elit. <br><\/h4><h5>Donec nisl libero, finibus malesuada finibus a, sollicitudin eget erat. <br><\/h5><p>Duis vitae pharetra mauris, id ornare urna. Ut in volutpat ipsum. Aliquam euismod nibh est. Ut maximus risus id malesuada egestas. Nunc nunc erat, porta id lectus at, semper pulvinar orci. Maecenas lobortis ex non euismod vulputate. Aliquam erat volutpat. Mauris mauris ligula, eleifend vitae lectus non, hendrerit pharetra leo. <br><\/p><p><br><\/p><ul><li>dsadsaddsadsad<\/li><li>dasdsadsadsad<\/li><li>dsadasdsadsa<br><\/li><\/ul><p><br><\/p><p>Duis vitae pharetra mauris, id ornare urna. Ut in volutpat ipsum. Aliquam euismod nibh est. Ut maximus risus id malesuada egestas. Nunc nunc erat, porta id lectus at, semper pulvinar orci. Maecenas lobortis ex non euismod vulputate. Aliquam erat volutpat. Mauris mauris ligula, eleifend vitae lectus non, hendrerit pharetra leo. <\/p> -a",
        "picture_urls": [
          "https:\/<projectURL>\/health_recommendations_pictures\/img_health_recommendations_12"
        ],
        "web_url": "",
        "last_change": "2020-04-16 10:38:46",
        "state": 1
      }
    ],
    "total_items": 4
  }
}


Get a recommendation

Get information about a specific recommendation
[badge-blue GET] /recommendations/{recommendation_id}

Path parameters

Parameter name Type Description
recommendation_id string The unique id for a recommendation

Response

Status code: 200 OK
Output structure : Recommendation

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/recommendations/8ad8b2b701199684f1222961d6
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDJhMDAxNmEyZjc1NDI3YWUwMTM0NmMyOWQxNmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==

Example response

HTTP/1.1 200 OK
Date: Tue, 20 Oct 2020 13:51:56 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "recommendation_id": "8ad8b2b701199684f1222961d6",
    "name": "Lorem ipsum dolor sit amet",
    "brief_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus bibendum orci suscipit mauris convallis sollicitudin. Morbi tempor bibendum dui quis placerat. Fusce sollicitudin metus a ante laoreet, id ultricies mi malesuada.",
    "detailed_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus bibendum orci suscipit mauris convallis sollicitudin. Morbi tempor bibendum dui quis placerat. Fusce sollicitudin metus a ante laoreet, id ultricies mi malesuada. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus bibendum orci suscipit mauris convallis sollicitudin. Morbi tempor bibendum dui quis placerat. Fusce sollicitudin metus a ante laoreet, id ultricies mi malesuada. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus bibendum orci suscipit mauris convallis sollicitudin. Morbi tempor bibendum dui quis placerat. Fusce sollicitudin metus a ante laoreet, id ultricies mi malesuada. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus bibendum orci suscipit mauris convallis sollicitudin. Morbi tempor bibendum dui quis placerat. Fusce sollicitudin metus a ante laoreet, id ultricies mi malesuada.",
    "content": "<p><i><b><u>Paste Options<\/u><\/b><\/i><\/p><p><u><br><\/u><\/p><p>The paste handler is a <b>built-in extension which attempts<\/b> to filter the content when the user pastes. <br><\/p><p>How the paste handler filters is configurable via specific options.<\/p><p><br><\/p><p><i>Options for paste handling are passed as an object that is a member of the outer options object.<\/i><\/p>",
    "picture_urls": [
      "https:\/<projectURL>\/health_recommendations_pictures\/img_health_recommendations_9"
    ],
    "web_url": "",
    "last_change": "2019-08-23 10:49:35",
    "state": 1
  }
}