Ugrás a fő tartalomra

Elemek kezelése (listák, lista mezők, űrlapok)

A bejegyzés tartalma:

Fiókhoz tartozó email listák lekérdezése

Visszaadja az adott SalesAutopilot fiókhoz tartozó email listák nevét és azonosítóját.

GET https://api.salesautopilot.com/getlists

Válasz

Válasz sikeres hívás esetén:

[{"id":"8637",
  "name":"CRM-lista"},
 {"id":"21849",
  "name":"PiacepitoRendszerReg"}]

Válasz hiba esetén:

A megfelelő HTTP hibakód.

Email listához tartozó űrlapok lekérdezése

Visszaadja az adott email listához tartozó feliratkozó vagy megrendelés űrlapok nevét és azonosítóját.

GET https://api.salesautopilot.com/getforms/<listid>

vagy

GET https://api.salesautopilot.com/getforms/<listid>/<formtype>

Paraméterek

Leírás

<listid>

E-mail lista azonosítója. A listákhoz tartozó azonosítót a getlists metódussal lehet lekérdezni.

<formtype>

Űrlap típusa. Ha átadásra kerül, akkor csak az adott típusú űrlapok kerülnek visszaadásra.

Lehetséges értékei:

1 : feliratkozó űrlap
2 : adatmódosító űrlap
4 : megrendelő űrlap

Válasz

Válasz sikeres hívás esetén:

[{"id":"12345",
  "name":"mez\u0151 l\u00e9trehoz\u00e1shoz",
  "link":"http:\/\/salesautopilot.s3.amazonaws.com\/newsletter\/letter\/nl23543\/ns12345\/subscribe.html"},
  {"id":"56789",
  "name":"\u00dcgyf\u00e9llista felirat\u00e1s API-val",
  "link":"http:\/\/salesautopilot.s3.amazonaws.com\/newsletter\/letter\/nl23543\/ns56789\/subscribe.html"}]

Válasz hiba esetén:

A megfelelő HTTP hibakód.

Lista mezőinek lekérdezése

Visszaadja az adott list mezőinek neveit.

Csak a mezőnevek listázása

GET https://api.salesautopilot.com/listfields/<listid>

Paraméterek

Leírás

<listid>

E-mail lista azonosítója. A listákhoz tartozó azonosítót a getlists metódussal lehet lekérdezni.

Válasz

Válasz sikeres hívás esetén:

[id,subdate,email,mssys_firstname]

Mezőnév - mezőtípus párok listázása:

GET https://api.salesautopilot.com/listfields/<listid>/extended

Válasz

Válasz sikeres hívás esetén:

{"id":"integer","subdate":"datetime"}

Válasz hiba esetén:

A megfelelő HTTP hibakód.

Mező hozzáadása listához

Új mezőt hoz létre a listán.

POST https://api.salesautopilot.com/addlistfield/<listid>

Paraméterek

Leírás

<listid>

E-mail lista azonosítója. A listákhoz tartozó azonosítót a getlists metódussal lehet lekérdezni.

Törzsben átadandó értékek

Leírás

field_name

Mező neve az adatbázisban. Mezőkóddal ezen a néven hivatkozhat a mezőre. Ennek a névnek a listán egyedinek kell lennie.

field_label

Mező címkéje.

field_comment

Megjegyzés a mezőhöz

field_type

Mező típusa.

scale

Tizedesek száma

options

Az opciók JSON objektumként megadva.

A következő értékek elfogadottak a mező típusához:

shorttext

Rövid szövegbeviteli mező

text

Több soros szövegdoboz

integer

Szám beviteli mező

decimal

Tizedestört beviteli mező.
Kötelező plusz paraméter: scale

checkbox

Jelölőnégyzet

radio

Rádiógomb.
Opcionális plusz paraméter: options

select

Legördülő panel.
Opcionális plusz paraméter: options

date

Dátum

datetime

Időpont

url

Webcím

file

Fájl

password

Jelszó

Hívás törzse:

{
	"field_name": "termek_szine",
	"field_label": "Termék színe",
	"field_comment": "A megrendelt termék színe",
	"field_type": "radio",
	"options" : {"zold" : "Zöld", "kek" : "Kék", "piros" : "Piros"}
}

Válasz

Válasz sikeres hívás esetén:

1

Válasz hiba esetén:

A megfelelő HTTP hibakód.

Mező létezésének ellenőrzése

Visszaadja, hogy létezik-e az adott listán mező ezzel a mezőnévvel.

POST https://api.salesautopilot.com/checkfieldexists/<listid>/<fieldname>

Paraméterek

Leírás

<listid>

E-mail lista azonosítója. A listákhoz tartozó azonosítót a getlists metódussal lehet lekérdezni.

<fieldname>

Mező neve az adatbázisban.

Válasz mező létezése esetén

1

Válasz mező nem létezése esetén

0

Legördülő vagy rádiógomb típusú mező opciónak lekérdezése

Visszaadja az adott listá mezőjéhez tartozó opciók értékét és címkéjét.

GET https://api.salesautopilot.com/getfieldoptions/<listid>/<fieldname>

Paraméterek

Leírás

<listid>

E-mail lista azonosítója. A listákhoz tartozó azonosítót a getlists metódussal lehet lekérdezni.

<fieldname>

Mező neve, amelynek az opcióit le szeretné kérdezni.

Válasz

Válasz sikeres hívás esetén:

[{"id":"12345",
  "value":"1",
  "label":"Els\u0151"},
  {"id":"12346",
  "value":"2",
  "label":"M\u00e1sodik"}]

Válasz hiba esetén:

A megfelelő HTTP hibakód.

Mező opció hozzáadása

Legördülő illetve rádiógomb típusú mező opcióihoz hozzáad egy újat.

POST https://api.salesautopilot.com/fieldoptionadd/<listid>/<fieldname>

Paraméterek

Leírás

<listid>

E-mail lista azonosítója. A listákhoz tartozó azonosítót a getlists metódussal lehet lekérdezni.

<fieldname>

Mező neve, amelynek az opcióit le szeretné kérdezni.

Hívás törzse:

{"value" : "Opció értéke",
 "text"  : "Opció címkéje"}

Válasz sikeres végrehajtás esetén

1

Válasz hiba esetén:

A megfelelő HTTP hibakód.

Mező opciójának módosítása

Legördülő illetve rádiógomb típusú mező opciója értékének és címkéjének módosítása.

POSThttps://api.salesautopilot.com/fieldoptionedit/<listid>/<fieldname>/<optionvalue>

Paraméterek

Leírás

<listid>

E-mail lista azonosítója. A listákhoz tartozó azonosítót a getlists metódussal lehet lekérdezni.

<fieldname>

Mező neve, amelynek az opcióit le szeretné kérdezni.

<optionvalue>

A módosítandó opció értéke.

Hívás törzse:

	{"value" : "Opció új értéke",
	 "text"  : "Opció új címkéje"}

Válasz sikeres végrehajtás esetén

1

Válasz hiba esetén:

A megfelelő HTTP hibakód.

Mező opciójának törlése

Legördülő illetve rádiógomb típusú mező egyik opciójának törlése.

POSThttps://api.salesautopilot.com/fieldoptiondelete/<listid>/<fieldname>/<optionvalue>

Paraméterek

Leírás

<listid>

E-mail lista azonosítója. A listákhoz tartozó azonosítót a getlists metódussal lehet lekérdezni.

<fieldname>

Mező neve, amelynek az opcióit le szeretné kérdezni.

<optionvalue>

A módosítandó opció értéke.

Válasz sikeres végrehajtás esetén

1

Válasz hiba esetén:

A megfelelő HTTP hibakód.

Választ kapott a kérdésére?