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": "Profilování - souhlas s profilováním v souladu s GDPR",
        "text": "<h1>Souhlas se zpracováním osobních údajů<\/h1><p>Tímto se dobrovolně a svobodně registruji do systému n.joy 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 n.joy card<\/h2><ul><li>Zařazení do databáze členů n.joy 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><h2>Zpracovávanými údaji jsou:<\/h2><ul><li>Jméno, příjmení, pohlaví, datum narození, adresa bydliště, email, telefon<\/li><li>Elektronické a jiné údaje o mých nákupních zvyklostech<\/li><\/ul><p>ve smyslu ust. § 5 odst. 2 zákona č. 101\/2000 Sb., o ochraně osobních údajů (dále jen „Zákon“), a od 25. 5. 2018 ve smyslu čl. 7 nařízení Evropského parlamentu a Rady (EU) 2016\/679 o ochraně fyzických osob v souvislosti se zpracováním osobních údajů a o volném pohybu těchto údajů a o zrušení směrnice 95\/46\/ES (obecné nařízení o ochraně osobních údajů) („Nařízení“), a to na dobu do odvolání tohoto souhlasu, příp. do doby ukončení členství v klubu n.joy card odhlášením dle čl. 10 Všeobecných pravidel zákaznického klubu nebo ukončení činnosti tohoto klubu.<\/p><p>Správcem mých osobních údajů je společnost Cortex, a.s. se sídlem U Elektry 974\/1c, 190 00, Praha 9, IČO: 471 256 16, (DPO: Ondřej Pexa, ondrej.pexa@cortex.cz) a obchodní partner programu n.joy card.<\/p><h2>Beru na vědomí, že:<\/h2><ul><li>mám právo požadovat od správce osobních údajů přístup ke svým osobním údajům, mám právo na jejich přenositelnost, jejich opravu nebo výmaz, popřípadě omezení zpracování, vznést námitku proti zpracování a svůj souhlas mohu kdykoliv písemně odvolat, a to písemně na adresu sídla společnosti Cortex, a.s., nebo zasláním e-mailu na adresu info@njoycard.cz,<\/li><li>mám právo vznést kdykoli a bezplatně námitku proti tomuto zpracování, včetně profilování, v rozsahu, v němž souvisí s konkrétní formou přímého marketingu, a to kterýmkoli ze způsobů uvedených v předchozím bodě,<\/li><li>společnost Cortex, a.s.. osobní údaje zlikviduje, jakmile pomine účel, pro který byly mé osobní údaje zpracovány,<\/li><li>mám právo podat stížnost u dozorového úřadu,<\/li><li>nemám povinnost osobní údaje společnosti Cortex, a.s. poskytnout, přičemž, pokud tak neučiním, nebude to pro mne mít žádné právní následky,<\/li><li>další informace o GDPR a ochraně osobních údajů najdu zde www.njoycard.cz.<\/li><\/ul><p>Beru na vědomí, že mé osobní údaje nejsou předávány spole\u010dností Cortex, a.s. žádným zahraničním ani tuzemským subjektům.<\/p><p>Souhlasím s tím, že mé osobní údaje budou v rozsahu poskytnutých údajů zpracovávány manuálně v písemné formě a automatizovaně v elektronické formě, a to vlastními zaměstnanci správce nebo zpracovatele.<\/p><p>Potvrzuji, že na mé přihlášce jsou správné údaje a že jsem se dostatečně seznámil(a) se zněním svého souhlasu se zpracováním osobních údajů poskytovaného společnosti Cortex, a.s., souhlas považuji za srozumitelný a jasný.<\/p>",
        "last_change": "2018-05-07 14:26:19.215774"
      },
      {
        "agreement_id": "8fd73167342d06899c4c015320",
        "name": "test rest api",
        "text": "test rest api content",
        "last_change": "2020-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": "Profilování - souhlas s profilováním v souladu s GDPR",
    "text": "<h1>Souhlas se zpracováním osobních údajů<\/h1><p>Tímto se dobrovolně a svobodně registruji do systému n.joy 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 n.joy card<\/h2><ul><li>Zařazení do databáze členů n.joy 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><h2>Zpracovávanými údaji jsou:<\/h2><ul><li>Jméno, příjmení, pohlaví, datum narození, adresa bydliště, email, telefon<\/li><li>Elektronické a jiné údaje o mých nákupních zvyklostech<\/li><\/ul><p>ve smyslu ust. § 5 odst. 2 zákona č. 101\/2000 Sb., o ochraně osobních údajů (dále jen „Zákon“), a od 25. 5. 2018 ve smyslu čl. 7 nařízení Evropského parlamentu a Rady (EU) 2016\/679 o ochraně fyzických osob v souvislosti se zpracováním osobních údajů a o volném pohybu těchto údajů a o zrušení směrnice 95\/46\/ES (obecné nařízení o ochraně osobních údajů) („Nařízení“), a to na dobu do odvolání tohoto souhlasu, příp. do doby ukončení členství v klubu n.joy card odhlášením dle čl. 10 Všeobecných pravidel zákaznického klubu nebo ukončení činnosti tohoto klubu.<\/p><p>Správcem mých osobních údajů je společnost Cortex, a.s. se sídlem U Elektry 974\/1c, 190 00, Praha 9, IČO: 471 256 16, (DPO: Ondřej Pexa, ondrej.pexa@cortex.cz) a obchodní partner programu n.joy card.<\/p><h2>Beru na vědomí, že:<\/h2><ul><li>mám právo požadovat od správce osobních údajů přístup ke svým osobním údajům, mám právo na jejich přenositelnost, jejich opravu nebo výmaz, popřípadě omezení zpracování, vznést námitku proti zpracování a svůj souhlas mohu kdykoliv písemně odvolat, a to písemně na adresu sídla společnosti Cortex, a.s., nebo zasláním e-mailu na adresu info@njoycard.cz,<\/li><li>mám právo vznést kdykoli a bezplatně námitku proti tomuto zpracování, včetně profilování, v rozsahu, v němž souvisí s konkrétní formou přímého marketingu, a to kterýmkoli ze způsobů uvedených v předchozím bodě,<\/li><li>společnost Cortex, a.s.. osobní údaje zlikviduje, jakmile pomine účel, pro který byly mé osobní údaje zpracovány,<\/li><li>mám právo podat stížnost u dozorového úřadu,<\/li><li>nemám povinnost osobní údaje společnosti Cortex, a.s. poskytnout, přičemž, pokud tak neučiním, nebude to pro mne mít žádné právní následky,<\/li><li>další informace o GDPR a ochraně osobních údajů najdu zde www.njoycard.cz.<\/li><\/ul><p>Beru na vědomí, že mé osobní údaje nejsou předávány společností Cortex, a.s. žádným zahraničním ani tuzemským subjektům.<\/p><p>Souhlasím s tím, že mé osobní údaje budou v rozsahu poskytnutých údajů zpracovávány manuálně v písemné formě a automatizovaně v elektronické formě, a to vlastními zaměstnanci správce nebo zpracovatele.<\/p><p>Potvrzuji, že na mé přihlášce jsou správné údaje a že jsem se dostatečně seznámil(a) se zněním svého souhlasu se zpracováním osobních údajů poskytovaného společnosti Cortex, a.s., souhlas považuji za srozumitelný a jasný.<\/p>",
    "last_change": "2018-05-07 14:26:19.215774"
  }
}