Zoznam operácií pre zdroj
| Názov | URL | Popis |
|---|---|---|
| Informácie užívateľa | /user | Detailné informácie o prihlásenom užívateľovi, identifikovanom podľa parametrov token a token_secret |
| Tvorba užívateľského účtu | /user/create | Vzdialená tvorba užívateľského účtu. V predvolenom nastavení je vytvorený Enterprise účet. |
| Informácie o vyplneniach účtu užívateľa | /user/responses | Táto operácia vracia informácie o vyplnení z posledného týždňa pre všetky dotazníky účtu používateľa. |
Popis parametrov odpovede
| Názov/cesta | Popis | Možné hodnoty |
|---|---|---|
id | ID užívateľa | |
email | E-mailová adresa užívateľa | |
md5_password | Heslo skrátené funkciou md5, ktoré sa používa pre prihlásenie prostredníctvom API | |
login_key | md5 kľúč slúžiaci pre prihlásenie. Štruktúra prihlasovacieho odkazu do užívateľského panelu je: https://www.netquest.sk/ prihlaseni/link/:login_key/:id, kde login_key je hodnota parametra login_key a id a je ID používateľa. | |
registration_date | Dátum registrácie na webovej stránke | |
activation_date | Dátum aktivácie účtu (potvrdenie registrácie) | |
expiration_date | Dátum vypršania účtu – pre Business a Enterprise účty | |
type | Typ účtu | business – Business účetenterprise – Enterprise účet |
company | Názov spoločnosti | |
street | Adresa spoločnosti | |
postal_code | Poštovný kód | |
city | Mesto | |
company_registration_number | IČ | |
surveys_count | Počet dotazníkov účtu | |
id_response | ID vyplnenie použitého na vyplnenie viacstránkových dotazníkov. Použitý s respondent_key parametrom | |
id_survey | ID dotazníka | |
token | Unikátny token, ktorý presne identifikuje respondenta. Použitý pre jednorazové vyplnenie dotazníka respondentom. Tento parameter je aktívny len pre najvyššiu úroveň ochrany dotazníka. | |
date_survey_open | Dátum a hodina prvého otvorenia dotazníka. Tento parameter je aktívny len pre dotazníky s najvyššou úrovňou ochrany. | null – Dotazník nebol otvorený respondentom2012-12-06 12:00:00 – Dátum a hodina otvorenia dotazníka |
date_survey_answer | Dátum a hodina vyplnenia dotazníka. Tento parameter je aktívny len pre dotazníky s najvyššou úrovňou ochrany. | null – Dotazník nebol vyplnený respondentom2012-12-06 12:00:00 – Dátum a hodina otvorenia dotazníka |
Informácie užívateľa
URL
(GET) https://www.netquest.sk/api/user
Parametre
Žiadne
Ukážka odpovede
{
"email":"[email protected]",
"registration_date":"2010-01-01 00:00:00",
"activation_date":"2010-01-01 01:00:00",
"expiration_date":"2012-01-01 00:00:00",
"type":"Business",
"company":"Digital Heads, s.r.o.",
"street":"Vinohradská 2828/151",
"postal-code":"130 00",
"city":"Praha",
"company_registration_number":"000-000-00-00",
"surveys_count":"11"
}
Chybové hlášky
Žiadne
Tvorba užívateľského účtu
URL
(GET) https://www.netquest.sk/api/user/create
Parametre (POST)
| Názov | Popis |
|---|---|
email | E-mailová adresa, na ktorú bude účet zaregistrovaný |
firstname | Meno majiteľa účtu |
fm_api_key | Kľúč do služby API Freshmail. Nepovinný parameter |
fm_api_secret | Secret kľúč do API služby Freshmail. nepovinný parameter |
Ukážka odpovede
{
"id":"1234"
"email":"[email protected]",
"md5_password":"663964500831381fc657ce86690fb0c0",
"login_key":"657ce86690fb0c0663964500831381fc",
"type":"biznes"
}
Chybové hlášky
404 Nenalezeno– Neplatná e-mailová adresa alebo je už adresa zaregistrovaná.406 Nepřijatelné– Parameter:emailnebol predaný.500 Interní chyba serveru– Interná chyba servera.
Informácie o vyplnení účtu užívateľa
URL
(GET) https://www.netquest.sk/api/user/responses
Nepovinné parametre (POST)
| Názov | Popis |
|---|---|
title | Názov dotazníka |
date_survey_open_lower | Minimálny dátum začiatku vypĺňania dotazníka. Dátum musí byť odoslaný vo formáte YYYY-MM-DD (napr. 2013-11-20).Po odoslaní parametra budú vrátené vyplnenia z tohto a nasledujúceho dňa. |
date_survey_open_upper | Maximálny dátum začiatku vypĺňania dotazníka. Dátum musí byť odoslaný vo formáte YYYY-MM-DD (napr. 2013-11-20).Po odoslaní parametra budú vrátené vyplnenia z tohto a nasledujúceho dňa. |
external_key | Hodnota odovzdaná do dotazníka ako parameter external_key. Vďaka tomu môžete triediť všetky vyplnenia z daného zdroja. Viac informácií o external_key najde tu. |
sm_client_id | Hodnota odovzdávaná do dotazníka v prípade zapnutej integrácie so službou Sales Manago. Vďaka tomu môžete triediť všetky vyplnenia s daným profilom. |
limit | Limit v počte záznamov |
offset | Offset v záznamoch |
Ukážka odpovede
[
{
id_response: 123,
id_survey: 123,
token: "2a5089",
user_token: "ola1983",
date_survey_open: "2012-12-06 12:00:00",
date_survey_answer: "2012-12-06 12:00:00"
}
]
Chybové hlášky
Žiadne