Cím műveletek

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

Címek listázása

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

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

Egy kiválasztott kontakt címeinek lekérdezése.

A válaszban a találatok egy tömbben érkeznek, melynek Count kulcsán található a talált címek száma. A Results kulcs alatt találhatóak a címek adatai, melyeknek kulcsai a címek azonosítói.

Példa válasz:

{
   "Count":2,
   "Results":[
      {
         "123":"Lakás címe (5555 Budapest Kiss utca 1.)",
         "456":"Iroda címe (4444 Újfalu Fő utca 14.)"
      }
   ]
}

Amennyiben XML formátumban használod az API-t, az előbbi lekérdezés nem téríti vissza a címekhez tartozó azonosítókat. Ilyen esetben egy struktúrált lekérdezést kell végrehajtani, amely a Structured paraméter segítségével lehetséges.

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

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/AddressList/1234?Structured=1

Egy kiválasztott kontakt címeinek lekérdezése.

A válaszban a találatok egy tömbben érkeznek, melynek Count kulcsán található a talált címek száma. A Results kulcs alatt találhatóak a címek strukturált adatai.

Példa válasz:

{
    "Results": {
        "123": {
            "Id": 123,
            "Address": "Lakás címe (5555 Budapest Kiss utca 1.)",
            "Url": "https://r3.minicrm.hu/Api/R3/Address/123"
    },
        "456": {
            "Id": 456,
            "Address": "Iroda címe (4444 Újfalu Fő utca 14.)",
            "Url": "https://r3.minicrm.hu/Api/R3/Address/465"
        }
},
    "Count": 2
}

Cím letöltése

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

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Address/123

Egy kiválasztott cím adatainak lekérdezése.

Válaszban a cím egy tömbben érkezik, ahol megtalálhatóak a cím adatai.

Példa válasz:

{
   "Id":123,
   "ContactId":1234,
   "Type":"Székhely",
   "Name":"Lakás címe",
   "CountryId":"Magyarország",
   "PostalCode":5555,
   "City":"Budapest",
   "Address":"Kiss utca 1.",
   "Default":1
}

 Cím módosítása

Meglévő cím 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 a 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/Address/123 -d '{
 "Address":"Fehérvári út 128.",
 "Name":"Munkahely címe"
}'

A szolgáltatás URL megegyezik a cím letöltés URL-jével. GET kéréssel cím letöltés kezdeményezhető, PUT kéréssel pedig adatmódosítás. Új cím felvétele az azonosító kihagyásával lehetséges (példa url végén található 123 lehagyása). Fontos itt megjegyezni, hogy új cím esetén a ContactId mező küldése kötelezőmeglévő cím esetén pedig a ContactId mező már 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":123
}