API Documentatie
versie {{:: vm.version }}

APIVersionTypesCredits
{{ format.name }}{{:: format.version }}{{:: format.types.join(', ') }}{{:: format.remainingCredits | number }} / {{:: format.credits | number }}

Keys

API keyNaamStatusCreated
{{:: k.apiKey }}{{:: k.payload.name }}{{:: k.createdOn | date : 'HH:mm dd-MM-yyyy' }}

Authenticatie

Authenticatie van deze API gaat middels een ApiKey header, deze key is in de portal van Ad Hoc Data aan te maken. Mocht je deze key nog niet hebben, vraag deze dan op bij de opdrachtgever. Daarnaast moet bij een POST call de Content-Type header gevuld worden.

Verplichte headers
ApiKey: {key}
Content-Type: application/json

Opmerkingen

  • Deze API verwacht en levert data uit in JSON formaat. Bij een 415 - unsupported media type status, check de Content-Type header. Klik hier voor meer informatie over RESTful API services.
  • JSON properties hieronder beschreven zijn case sensitive. Bij afwijken in casing kan het zijn dat de waarde niet wordt verwerkt.
  • Er geldt een limiet van 2 calls per seconde. Bij overschijden van dit limit zal een status 429 too many requests geretourneerd worden.

Lookup API

[GET] {{:: vm.apiBase }}/lookup/{{:: vm.format }}/{{:: vm.version }}/{{variant.name}}/{{ variant.params }}

URL parameters

preview = true / false, default: true
take = integer, default: 1
skip = integer, default: 0
fields = komma gescheiden output velden, default: zie output

Voorbeeld output

Voor de exacte output data, zie output

{{ vm.crmOutExample | json }}

CRM API

[POST] {{:: vm.apiBase }}/crm/{{:: vm.format }}/{{:: vm.version }}

Standaard waarden

_take = integer, default: {{:: vm.docs.specs.CrmPageSize }}
_skip = integer, default: 0
_preview = true / false, default: true
fields = komma gescheiden output velden, default: zie output

Voorbeeld

Input

Voor de exacte input data, zie input

{{ vm.crmInExample | json }}

Output

Voor de exacte output data, zie output

{{ vm.crmOutExample | json }}

Query API

[POST] {{:: vm.apiBase }}/query/{{:: vm.format }}/{{:: vm.version }}

Voorbeeld telling

Input

Voor de exacte input data, zie input

{{ vm.queryInCountExample | json }}

Output

 

{{ vm.queryOutCountExample | json }}

Voorbeeld exporteren data

Input

Voor de exacte input data, zie input

{{ vm.queryInExample('Get') | json }}

Output

Voor de exacte output data, zie output

{{ vm.queryOutGetExample | json }}

Voorbeeld preview

Input

Voor de exacte input data, zie input

{{ vm.queryInExample('Preview') | json }}

Output

Voor de exacte output data, zie output

{{ vm.queryOutPreviewExample | json }}

Filter types

IS / !ISExacte match
IN / !INWaarde in komma gescheiden lijst
CONTAINS / !CONTAINSBevat waarde
BETWEEN / !BETWEENRange, waarbij min/max komma gescheiden wordt opgegeven
STARTSWITHBegint met waarde
ENDSWITHEindigt met waarde
GTGroter dan
LTKleiner dan
ANDGROUPGroep van bovengenoemde filters icm AND operator, voorbeeld:
{
   "Type": "ANDGROUP",
   "Conditions": [ {
      "Field": "POSTCODE",
      "Type": "IS",
      "Value": "2514AA"
   },
   {
      "Field": "POSTCODE",
      "Type": "IS",
      "Value": "2514AD"
   }]
}
ORGROUPGroep van bovengenoemde filters icm OR operator, voorbeeld:
{
   "Type": "ORGROUP",
   "Conditions": [ {
      "Field": "POSTCODE",
      "Type": "IS",
      "Value": "2514AA"
   },
   {
      "Field": "POSTCODE",
      "Type": "IS",
      "Value": "2514AD"
   }]
}
UNIONIN statement icm met meerdere velden, voorbeeld:
{
   "Field": "sbi1,sbi2,sbi3",
   "Type": "UNION",
   "Value": "CODE1,CODE2,CODE3"
}

Referentie lijsten

  • [GET] {{:: vm.apiBase }}/references/{{:: vm.format }}/{{:: vm.version }}/lists/{{ list }}

Input

FieldData typeData lengthOmschrijving
{{:: key }}{{:: value.DataType }}{{:: value.DataLength }} 

Output

FieldPreviewStandaard uitvoerData typeData lengthOmschrijving
{{:: key }}{{:: value.DataType }}{{:: value.DataLength }} 
Loading...