<< Click to Display Table of Contents >> Navigation:  Web API > Web API HttpGet

 

De HttpGet aanroep wordt gebruikt om gegevens op te vragen uit de Logicworks CRM database.  Om deze gegevens op te vragen dient te aanroepende partij te beschikken over de juiste Web API Authenticatie Token en leesrechten in het betreffende object.

 

 

JSON

De geselecteerde gegevens worden altijd als een JSON (JavaScript Object Notation) string geretourneerd aan de aanroepende partij. Meer informatie over deze notatie is te lezen op de website www.json.org.

 

 

HttpGet List query definieren

Alvorens een externe partij voor een entiteit een HttpGet verzoek kan indienen bij de de Web API  moet een HttpGet List query worden gedefinieerd in Logicworks CRM. Ter illustratie zal hieronder de Contactpersoon worden gebruikt, maar hetzelfde principe geldt voor alle andere entiteiten.

 

Maak via de menuoptie Designers > Query Builder een nieuwe query aan en definieer de kolommen welke geretourneerd mogen worden bij een algemene Web API aanvraag. Bij een dergelijke aanvraag wordt geen specifieke Contactpersoon ID meegegeven in de HttpGet aanroep, zodat een lijst met algemene contactpersoon-gegevens wordt geretourneerd. Een voorbeeld van een dergelijke aanroep is https://www.logicworkscrm.nl/api/contacts.

 

Op de laatste pagina van de Query Builder wizard dient bij Uitvoer te worden gekozen voor 'Web API lijst' en bij Object voor 'Contactpersoon'. De Web API service weet zo dat deze query is bedoeld om een lijst met contactpersonen te retourneren bij de aanroep https://www.logicworkscrm.nl/api/contacts.

 

 

HttpGet Detail query definieren

Als de Web API service wordt aangeroepen met een HttpGet opdracht in combinatie met een ID, dan zal gedetailleerde informatie van het betreffende entiteit moeten worden geretourneerd. Een voorbeeld van een dergelijke aanroep is https://www.logicworkscrm.nl/api/contacts/00020. Hierbij refereert de ID '00020' aan de Contactpersoon, waarvan de detailgegevens worden opgevraagd.

 

Maak via de menuoptie Designers > Query Builder een nieuwe query aan en definieer de kolommen welke geretourneerd mogen worden bij een Web API detail aanvraag. Bij een dergelijke aanvraag wordt altijd specifieke Contactpersoon ID meegegeven in de HttpGet aanroep.

 

Op de laatste pagina van de Query Builder wizard dient bij Uitvoer te worden gekozen voor 'Web API details' en bij Object voor 'Contactpersoon'. De Web API service weet zo dat deze query is bedoeld om detailgegevens van een specifieke contactpersoon te retourneren bij de aanroep https://www.logicworkscrm.nl/api/contacts/00020.

 

 

 

 

HttpGet aanroep

De Web API aanroep heeft altijd een vaste indeling, aangevuld met de Web API Token en eventuele extra selectieparameters.

 

https://www.logicworkcrm.nl/api/{object}?apitoken={token}

Met deze aanroep wordt een JSON-lijst geretourneerd van het opgegeven {object}.

 

https://www.logicworkcrm.nl/api/{object}/{id}?apitoken={token}

Met deze aanroep wordt een JSON-object geretourneerd met de detailgegevens behorende bij het opgegeven {id}.

 

 

HttpGet parameters

Er kunnen diverse parameters worden meegegeven met de Web API aanroep. Met uitzondering van de apitoken-parameter, welke altijd verplicht is, hebben deze parameters puur betrekking op de lijst-gerelateerde aanroep.

 

apitoken (verplicht)

Hiermee wordt Web API token doorgegeven

 

Voorbeeld

https://www.logicworkcrm.nl/api/contacts?apitoken=12345

 

 

page (optioneel, default=1)

Geef het paginanummer op dat moet worden geretourneerd, waarbij rekening wordt gehouden met het aantal regels per pagina dat met de parameter 'rows' dat wordt doorgegeven.

 

Voorbeeld

https://www.logicworkcrm.nl/api/contacts?apitoken=12345&page=1&rows=50

 

 

rows (optioneel, default=100)

Geef het aantal regels op dat moet worden geretourneerd.

 

Voorbeeld

https://www.logicworkcrm.nl/api/contacts?apitoken=12345&page=1&rows=50

 

 

sortby (optioneel, default=sleutelveld)

Standaard worden de geretourneerd records gesorteerd op het sleutelveld. Is een andere sortering echter gewenst, dan kan dat worden opgegeven met de parameter 'sortby'. Het is mogelijk op meerdere kolommen te sorteren, door deze met een komma gescheiden door te geven. Let op dat het noodzakelijk is hierbij de daadwerkelijke database veldnaam aan te houden en niet de vertaalde veldnaam te gebruiken.

 

Voorbeeld

https://www.logicworkcrm.nl/api/contacts?apitoken=12345&sortby=lastname,initials

 

 

term (optioneel)

Het is mogelijk de lijst met te retourneren records te filteren op het voorkomen van bepaalde waarden in een of meerdere kolommen. Daarom dient deze parameter altijd in combinatie met de parameter 'fields' te worden gebruikt.

 

Voorbeeld

https://www.logicworkcrm.nl/api/contacts?apitoken=12345&term=heijer&fields=lastname

 

 

fields (optioneel)

Bij deze parameter worden een of meerdere komma-gescheiden kolommen doorgegeven waarin de via de parameter 'term' opgegeven zoekterm moet voorkomen. Ook nu is het noodzakelijk de daadwerkelijke database veldnaam te gebruiken en niet de vertaalde veldnaam.

 

Voorbeeld

https://www.logicworkcrm.nl/api/contacts?apitoken=12345&term=6916271&fields=telephone1,telephone2,mobilephone