Interogarea și modificarea adreselor

Ultima versiune a documentației MiniCRM API (în limba engleză) poate fi consultată dând click pe următorul link: MiniCRM Api English.

Lista de adrese

Este necesară autentificarea:

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

Se interoghează adresele contactului al cărui Id este specificat.

Ca și răspuns va fi returnat un array al cărei cheie Count conține numărul de adrese găsite. Dedesubt, cheia Results va conține detaliile adreselor precum și identificatorul acestora.

Exemplu de răspuns:

{
   "Count":2,
   "Results":[
      {
         "123":"Adresa acasă (Test adresă acasă)",
         "456":"Adresa birou (Test adresă birou)"
      }
   ]
}

Dacă folosești API în format XML, interogarea nu va returna identificatorul adresei ci va fi nevoie să se facă o interogare folosind parametrul Structured:

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

Vor fi interogate adresele contactului al cărui Id a fost specificat.

Răspunsul primit va fi sub forma unui array. Cheia Count va conține numărul de adrese găsit iar dedesubt, cheia Results va conține detaliile structurate ale adreselor.

Exemplu de răspuns:

{
    "Results": {
        "123": {
            "Id": 123,
            "Address": "Adresa acasă (Test adresă acasă)",
            "Url": "https://r3.minicrm.hu/Api/R3/Address/123"
    },
        "456": {
            "Id": 456,
            "Address": "Adresa birou (Test adresă birou)",
            "Url": "https://r3.minicrm.hu/Api/R3/Address/465"
        }
},
    "Count": 2
}

Preluarea detaliilor unei adrese

Este necesară autentificarea:

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

Este interogată adresa al cărei Id este specificat iar ca și răspuns se primește un array care conține toate detaliile adresei.

Exemplu de răspuns:

{
   "Id":123,
   "ContactId":1234,
   "Type":"Sediul principal",
   "Name":"Adresă birou",
   "CountryId":"România",
   "PostalCode":123456,
   "City":"Cluj-Napoca",
   "Address":"Strada Arieșului",
   "Default":1
}

Modificarea unei adrese

Se poate modifica o adresă existentă sau se poate crea o nouă adresă. Este necesară autentificarea:

$ curl -XPUT https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Address/123 -d '{
 "Address":"Strada Testului, nr. 1",
 "Name":"Adresa birou"
}'

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 (123 în exemplul de URL de mai sus).

Structura de date așteptată pentru input este un array JSON serializat.

Exemplu de răspuns pentru salvarea cu succes a informațiilor:

{
  "Id":123
}