Teendő műveletek

A legfrissebb MiniCRM API dokumentációnk az alábbi linken érhető el:
http://cdn.minicrm.hu/media/MiniCRM-Api-Hungarian.pdf

Teendők listázása

Azonosítás szükséges, példa url:

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

Egy kiválasztott projekt teendőinek lekérdezése.

A válaszban a találatok egy tömbben érkeznek, melynek Count kulcsán található a talált teendők száma. A Results kulcs alatt egy-egy külön tömbben találhatóak a projekt teendői.

A listázott teendők státuszuk alapján szűrhetőek a Status paraméter segítségével. Ennek lehetséges értékei Open (nyitott teendők), Closed (lezárt teendők) és All (minden teendő) lehetnek. Példa a nyitott teendők listázására:

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

Példa válasz:

{
   "Count":2,
   "Results":[
      {
         "Id":"1111",
         "Status":"Open",
         "Comment":"Felhívni és megkérdezni sikerült-e dönteni, van-e még valamilyen kérdése a termékről.",
         "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":"Történt valami előrelépés?",
         "Deadline":"2013-01-22 23:59:00",
         "UserId":"3300",
         "Type":"1566",
         "Url":"https://r3.minicrm.hu/Api/R3/ToDo/2222"
      }
   ]
}

Teendő letöltése

 Azonosítás szükséges, példa url:

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

Egy kiválasztott teendő adatainak lekérdezése.

Válaszban a teendő egy tömbben érkezik, ahol megtalálhatóak a teendő adatai.

Példa válasz:

{
   "Id":1111,
   "UserId":"Keszei Csaba",
   "ContactId": 0,
   "ProjectId":2001,
   "Type":"",
   "Duration": 0,
   "Reminder": 0,
   "Status":"Open",
   "Mode": "Teendő",
   "Deadline":"2012-01-17 23:59:00",
   "Comment":"Felhívni és megkérdezni sikerült-e dönteni, van-e még valamilyen kérdése a termékről.",
   "Attachments":{
      "FileName":"szerzodes.pdf",
      "Url":"http://cdn.minicrm.hu/doc/2013/04-25/A/Q/AQFwQq7Os0kE5ykH_GSJfg-1"
   },
  "CreatedAt": "2012-01-17 00:01:59",
  "ClosedBy": "Keszei Csaba",
  "ClosedAt": "0000-00-00 00:00:00",
   AddressId: 3,
   "Members": [{
      "Entity": "Contact",
      "EntityId": "6"
   }],
   "Notes": [{
      "Comment": "Nem sikerült elérnem",
      "CreatedBy": "54726",
      "CreatedAt": "2012-01-17 12:48:17"
   }]
}

ContactId: Abban az esetben van jelentősége, ha a teendőnk ügyfélszolgálat modulban egy válasz email típusú teendő. Ebben az esetben a ContactId a címzett azonosítója.
Mode: Lehet “Teendő” vagy “Email”, az email szintén az ügyfélszolgálat modulnál aktuális.
AddressId: A teendőben megadott cím rendszerbeli azonosítója. Ez lekérdezhető az Address végponton keresztül. (https://www.minicrm.hu/help/cim-muveletek/)
Members: A teendőhöz felvett érintettek típusa és azonosítója.
Lekérdezhető a Contact végponton keresztül: https://www.minicrm.hu/help/kontakt-muveletek/
Notes: A teendőhöz írt komment.
Comment: A megjegyzés szövege
CreatedBy: Ki hozta létre (UserId)
Lekérdezhető a Schema/Project végponton keresztül: https://www.minicrm.hu/help/semak-lekerese/
CreatedAt: Mikor hozta létre

Fontos: a Members és a Notes csak olvasható értékek!

Teendő adatmódosítás

Meglévő teendő módosítása, vagy új létrehozása. Célszerű csak a módosult adatokat újraküldeni, így hatékonyabban futhatnak a programok, elkerülhető az időközben már módosult adatok visszaállítása korábban letöltött értékekre. Azonosítás szükséges, példa url:

$ curl -XPUT https://SystemId:APIKey@r3.minicrm.hu/Api/R3/ToDo/1111 -d '{
 "Comment":"Módosított szöveg",
 "Deadline":"2013-01-25 13:30:00"
}'

A szolgáltatás URL megegyezik a teendő letöltés URL-jével. GET kéréssel teendő letöltés kezdeményezhető, PUT kéréssel pedig adatmódosítás. Új teendő felvétele az azonosító kihagyásával lehetséges (példa url végén található 1111 lehagyása). Fontos itt megjegyezni, hogy új teendő esetén a ProjectId mező küldése kötelezőmeglévő teendő esetén pedig a ProjectId mező már nem szerkeszthető! Szerkeszteni csak a nyitott teendőket lehet, lezárt teendő nem szerkeszthető!

Bemeneten várt adatstruktúra megegyezik a teendő letöltéskor kapott struktúrával. Bemeneti formátum JSON serialized tömb.

Példa válasz sikeres mentés esetén:

{
  "Id":1111
}