Page tree
Skip to end of metadata
Go to start of metadata

Let op! Deze pagina is gericht op het aanroepen van GetConnectoren met resultaat in XML formaat. Ben je op zoek naar CSV formaat? Lees dan dit artikel.

Om een GetConnector aan te roepen via ProfitConnect in XML of JSON formaat heb je twee dingen nodig:

  1. Een (ingericht) Profit Connect Queue ID (met whitelist op het IP waar je verbindingen vandaan komen)
  2. Een GetConnectornaam welke de gegevens bevat om aan te roepen

Op Queue-niveau binnen Profit Connect wordt bepaald hoe om moet worden gegaan met caching. GetConnectoren kunnen live worden uitgevoerd, kunnen op cache terugvallen of kunnen op cache terugvallen indien live te lang duurt.

Het standaard Endpoint voor een GetConnector met XML resultaat op Profit Connect is:

Het standaard Endpoint voor een GetConnector met JSON resultaat op Profit Connect is:

Vervang hierbij [QUEUEID] voor het Queue ID binnen Profit Connect (normaal gesproken een 40 karakter lange SHA1 (A-F, 0-9) hash) en vervang [CONNECTORNAAM] voor de naam van de GetConnector zoals aanwezig binnen de aan de Queue gekoppelde AFAS Profit omgeving.
Let op! Het QUEUEID is de identifier die je toegang verschaft tot de data uit Profit en kan gezien worden als een wachtwoord. Het is dus belangrijk om het QUEUEID geheim te houden.

Parameters

Aansluitend zijn aan de Endpoint-URL de volgende parameters mee te geven in de URL:

Operator (URL)Omschrijving & voorbeeldwaarde(n)

sort_field:[FIELD]

Sorteer de resultaten op veld (uit de GetConnector) 

sort_direction:[DIRECTION]

Sorteer het veld in de richting: ASC of DESC (standaard, indien niet opgegeven: ASC)

filter:[FILTER]

 

 

 

 

 

 

 

 

Geef een filter door aan Profit volgens de AFAS Snelfilter Operators;

&   = Eindigt op
@  = Begint met
*    = Bevat
... Etc.

Geef meerdere filters op met && (2x 'en-teken')
Geef een of-filter op met || (2x 'pipe')

Bijvoorbeeld:

Naam eindigt op B.V. en Insturen = J (ja/true/waar) en Naam bevat iPub en NaamPersoon bevat Wietse

stylesheet:true

Geef de XML output in stylesheet (tabel) weer; enkel nuttig als de volgende optie ook aan staat;

return_empty_fields:[BOOL]

Geef ook de velden in de resultaten terug die geen waarde hebben (true of false, standaard false) 

skip:[INT]Skip X records bij het ophalen, -1 is n.v.t. (skip 0, take 10 = 10 records ophalen vanaf het begin)
take:[INT]Take X records bij het ophalen, -1 is n.v.t. (skip 0, take 10 = 10 records ophalen vanaf het begin)

Response-codes

CodeBetekenis

200

Connector Call OK
209Cache HIT, live call failed
219Connector Call OK (But retry was needed)
500Unspecified Exception
501Unknown queue-hash: unset or invalid
502Unknown Connector: unset or invalid
503Plugin cannot be found in customer namespace
504Plugin is incompatible (invalid Plugin type)
505Remote address is invalid for endpoint
514Plugin generates EXCEPTION
601Execute error, no cache was available
602No cache was available and retry failed
603No cache was available, no retry
620Queue not found or disabled