Általános tudnivalók a keresésről

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

 A válaszban a találatok egy tömbben érkeznek, melynek Count kulcsán található a talált elemek száma. A Results kulcs alatt egy-egy külön tömbben találhatóak a megtalált elemek. A listába csak a legfőbb adatok kerülnek be. Az egyes elemekről a teljes elérhető adat lekérdezhető API-n keresztül az Url mezőben kapott címről. Az API keresési oldalanként 100 találatot jelenít meg. A találatok lapozhatóak a Page paraméter segítségével, pl:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project?Query=Teszt&Page=1

Fontos, hogy a lapozás az API esetében 0-ról indul, tehát a második oldalt a Page=1 paraméterrel lehet elérni!

Mező alapú keresésnél további extra paraméter lehet az UpdatedSince, amivel csak olyan elemek kerülnek listázásra, amik a megadott dátum után lettek módosítva.

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project?StatusId=2500&UpdatedSince=2013-03-01+12:00:00

 Szabad szavas keresés Projektek között

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

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project?Query=Teszt

Ilyen esetben a szóra releváns projekteket keresi meg a rendszer. Fontos itt megjegyezni, hogy ilyen esetekben csak a Projektek között keres a rendszer!

Példa válasz:

{
  "Count": 1,
  "Results": {
    "1234": {
      "Id": "1234",
      "Name": "Teszt projekt",
      "Url": "https://r3.minicrm.hu/Api/R3/Project/1234",
      "StatusId": "2500",
      "UserId": "3200",
      "Deleted": "0"
    }
  }
}

Szabadszavas keresés Kontaktok között

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

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Contact?Query=Kovács

Ilyen esetben a szóra releváns kontaktokat keresi meg a rendszer. Fontos itt megjegyezni, hogy ilyen esetekben csak a Kontaktok között keres a rendszer! Telefonszámok keresésére ez a típusú keresés javasolt! Telefonszámok keresésekor a rendszer normalizálja a kapott telefonszámot és az alapján végzi a keresést. A keresés a telefonszámok végéről indul, így elég megadni a telefonszám utolsó számjegyeit, hogy releváns találatokat kapjunk. Példa Url:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Contact?Query=2345678

Példa válasz:

{
  "Count": 1,
  "Results": {
    "12345": {
      "Id": "12345",
      "Name": "Kovács József",
      "Url": "https://r3.minicrm.hu/Api/R3/Contact/12345",
      "Type": "Person",
      "Email": "kjozsef@teszt.hu",
      "Phone": "0612345678"
    }
  }
}