Agreements

You can get the list of the available customer agreements here.

Available methods

All available methods for resource agreements.

HTTP method Endpoint Description
[badge-blue GET] /agreements Get information about all agreements
[badge-blue GET] /agreements/{agreement_id} Get information about specific agreement

Get all agreements

Get a list of agreements accepted in CRM CareCloud
[badge-blue GET ] /agreements

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

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
agreements AgreementList[] List of the agreements
total_items integer Count of all found agreements

Example Request

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

Example response

HTTP/1.1 200 OK
Date: Tue, 04 Aug 2020 09:55:53 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "agreements": [
      {
        "agreement_id": "81eaeea13b8984a169c490a325",
        "name": "GDPR agreement",
        "text": "<h1>Souhlas se zpracováním osobních údajů<\/h1><p>Tímto se dobrovolně a svobodně registruji do systému card a uděluji souhlas se zpracováním osobních údajů poskytnutých při registraci, jakožto i dalších osobních údajů získaných při obchodním styku a v souvislosti s členstvím v systému za účelem:<\/p><h2>Operací spojených s provozováním systému card<\/h2><ul><li>Zařazení do databáze členů card systému<\/li><li>Nabízení slev členům systému (zvýhodněné ceny a zboží, sbírání bodů)<\/li><li>Zasílání obchodních sdělení<\/li><\/ul>",
        "last_change": "2018-05-07 14:26:19.215774"
      },
      {
        "agreement_id": "8fd73167342d06899c4c015320",
        "name": "Data profiling agreement",
        "text": "<h1>Souhlas se zpracováním osobních údajů<\/h1><p>Tímto se dobrovolně a svobodně registruji do systému card a uděluji souhlas se zpracováním osobních údajů poskytnutých při registraci, jakožto i dalších osobních údajů získaných při obchodním styku a v souvislosti s členstvím v systému za účelem:<\/p><h2>Operací spojených s provozováním systému card<\/h2><ul><li>Zařazení do databáze členů card systému<\/li><li>Nabízení slev členům systému (zvýhodněné ceny a zboží, sbírání bodů)<\/li><li>Zasílání obchodních sdělení<\/li><\/ul>",
        "last_change": "2018-04-17 15:31:21.395124"
      }
    ],
    "total_items": 2
  }
}


Detail of an agreement

Get information about a specific agreement
[badge-blue GET] /agreements/{agreement_id}

Path parameters

Parameter name Type Description
agreement_id string The unique id of an agreement in CareCloud

Response

Status code: 200 OK
Output structure : AgreementList

Example request

GET <projectURL>/rest-api/enterprise-interface/v1.0/agreements/81eaeea13b8984a169c490a325
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZWgEmEyZGFjZ3NmUzNDljNGYyMzlkOWQ0NA==

Example response

HTTP/1.1 200 OK
Date: Tue, 04 Aug 2020 10:08:13 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "agreement_id": "81eaeea13b8984a169c490a325",
    "name": "GDPR agreement",
    "text": "<h1>Souhlas se zpracováním osobních údajů<\/h1><p>Tímto se dobrovolně a svobodně registruji do systému card a uděluji souhlas se zpracováním osobních údajů poskytnutých při registraci, jakožto i dalších osobních údajů získaných při obchodním styku a v souvislosti s členstvím v systému za účelem:<\/p><h2>Operací spojených s provozováním systému card<\/h2><ul><li>Zařazení do databáze členů card systému<\/li><li>Nabízení slev členům systému (zvýhodněné ceny a zboží, sbírání bodů)<\/li><li>Zasílání obchodních sdělení<\/li><\/ul>",
    "last_change": "2018-05-07 14:26:19.215774"
  }
}