Interogarea și modificarea sarcinilor

Lista de sarcini

Este necesară autentificarea:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/ToDoList/1234

Funcționalitatea interoghează lista de sarcini a cardului al cărui Id este specificat.

Răspunsul va fi sub forma unui array în care cheia Count va conține numărul de sarcini găsit iar cheia Results va afișa sarcinile cardului în array-uri separate.

Sarcinile afișate pot fi filtrate în funcție de status folosind parametrul Status. Acesta poate avea una din următoarele valori: Open, Closed sau All.

Exemplu de interogare pentru sarcinile deschise:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/ToDoList/1234?Status=Open

Exemplu de răspuns:

{
   "Count":2,
   "Results":[
      {
         "Id":"1111",
         "Status":"Open",
         "Comment":"Exemplu sarcina 1.",
         "Deadline":"2012-01-17 23:59:00",
         "UserId":"3200",
         "Type":"0",
         "Url":"https://r3.minicrm.hu/Api/R3/ToDo/1111"
      },
      {
         "Id":"2222",
         "Status":"Open",
         "Comment":"Exemplu sarcina 2",
         "Deadline":"2013-01-22 23:59:00",
         "UserId":"3300",
         "Type":"1566",
         "Url":"https://r3.minicrm.hu/Api/R3/ToDo/2222"
      }
   ]
}

Preluarea detaliilor unei sarcini

Este necesară autentificarea:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/ToDo/1111

Funcționalitatea interoghează sarcina al cărei Id este specificat.

Ca și răspuns, se primește un array care conține detaliile sarcinii interogare.

Exemplu de răspuns:

{
   "Id":1111,
   "UserId":"Bogdan Burciu",
   "ContactId": 0,
   "ProjectId":2001,
   "Type":"",
   "Duration": 0,
   "Reminder": 0,
   "Status":"Open",
   "Mode": "Ce este de făcut?",
   "Deadline":"2012-01-17 23:59:00",
   "Comment":"Test comentariu.",
   "Attachments":{
      "FileName":"testfile.pdf",
      "Url":"http://cdn.minicrm.hu/doc/2013/04-25/A/Q/AQFwQq7Os0kE5ykH_GSJfg-1"
   },
  "CreatedAt": "2012-01-17 00:01:59",
  "ClosedBy": "Bogdan Burciu",
  "ClosedAt": "0000-00-00 00:00:00",
   AddressId: 3,
   "Members": [{
      "Entity": "Contact",
      "EntityId": "6"
   }],
   "Notes": [{
      "Comment": "Test comentariu.",
      "CreatedBy": "54726",
      "CreatedAt": "2012-01-17 12:48:17"
   }]
}

ContactId: este important dacă produsul are setat ca și modalitate de răspuns emailul (cum este produsul Helpdesk, de exemplu). În acest caz, ContactId-ul este id-ul destinatarului emailului.

Mode: Poate fi To Do sau Email (valoarea email este setată implicit pentru produsul Helpdesk).

AddressId: Id-ul adresei specificată în sarcină. Aceasta poate fi interogată prin endpoint-ul pentru Adrese și poți obține mai multe detalii accesând pagina dedicată.

Members: Tipul și id-ul persoanelor implicate în respectiva sarcină. Acestea pot fi interogate prin endpoint-ul pentru Contacte și poți obține mai multe detalii acesând pagina dedicată.

Notes: Acțiunea sau descrierea sarcinii.

Comment: Comentariile adăugate la o anumită sarcină.
CreatedBy: Id-ul utilizatorului care a creat sarcina.
CreatedAt: Data creeri sarcinei.

Modificarea unei sarcini

$ curl -XPUT https://SystemId:APIKey@r3.minicrm.hu/Api/R3/ToDo/1111 -d '{
 "Comment":"Test comentariu",
 "Deadline":"2013-01-25 13:30:00"
}'

Preluarea datelor poate fi inițializată cu cereri de tip GET iar cele de modificare cu cereri de tip PUT. Adăugarea unui nou card este posibilă prin omiterea identificatorului (1234 în exemplul de URL de mai sus). Pot fi editate doar sarcinile deschise.

Structura de date pentru input este de array JSON serializat.

Exemplu de răspuns pentru adăugarea cu succes a unei sarcini:

{
  "Id":1111
}