Filter

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

Filter

Bij het opvragen van gegevens kunnen, extra filters opgeven worden. Dit kan bij GetBookings, GetAspects en GetRelations.

 

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

field

string

verplicht

Veldnaam

De veldnaam moet in het resultaat/antwoord van de opgevraagde gegevens beschikbaar zijn. Zie hiervoor de Antwoord structuur van de betreffende Aanroep.

Wanneer er gebruikersvelden beschikbaar zijn dan kan de Interne naam van het gebruikersveld als veldnaam worden gebruikt om op te filteren.

operator

string

verplicht

Operator

Operator

Omschrijving

=

is

!=

is niet

>

groter dan 1)

>=

groter of gelijk 1)

<

kleiner dan 1)

<=

kleiner of gelijk 1)

$

bevat

!$

bevat niet

$*

begint met

!$*

begint niet met

..

in lijst

Tag/veldnaam value bevat dan een komma gescheiden lijst van te filteren waardes.

!..

niet in lijst

Tag/veldnaam value bevat dan een komma gescheiden lijst van te filteren waardes.

value

string

verplicht

Waarde waarop moet worden gefilterd

Tag/Veldnaam type

Opmerkingen/beperkingen

float

Waarde verplicht, numeriek. Er mag 1 decimale punt in voorkomen.

Bijv.: 14.99

integer

Waarde verplicht, numeriek.  Er mag géén decimaal scheidingsteken in voorkomen.

Bijv.: 100

string

Geen bijzonderheden (Waarde mag leeg zijn)

boolean

Waarde verplicht. Geldige waardes zijn: true of false

date

Waarde verplicht. Waarde moet voldoen aan het formaat: yyyy-MM-dd.

Bijv.: 2018-01-31 (is 31 januari 2018)

 

Indien er op datum + tijd moet worden gefilterd is het formaat: yyyy-MM-ddThh:mm:ss.SSS.

yyyy = jaar in 4 cijfers.

MM = maand in 2 cijfers (01 t/m 12).

dd = dag van de maand in 2 cijfers.

T = scheidingsteken tussen datum en tijd

hh = uren in 2 cijfers (00 t/m 23).

mm = minuten in 2 cijfers (00 t/m 59).

ss = seconden in 2 cijfers (00 t/m 59).

SSS = milliseconden in 3 cijfers (000 t/m 999).

1) Let op: zorg ervoor dat het systeem (library) dat de soap berichten genereert de > (groter dan) en < (kleiner dan) tekens correct xml-escaped (i.e. &gt; en &lt;)

 

Voorbeeld

Als voorbeeld kan het filter gebruikt worden om nieuwe en/of gewijzigde gegevens op te vragen vanaf een bepaalde datum. Dit kan door een filter te maken op het veld TIMESTAMP, zoals hieronder:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetBookings xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <startDate>2021-04-01</startDate>

    <endDate>2021-05-01</endDate>

    <filters>

      <filter>

        <field>TIMESTAMP</field>

        <operator>&gt;</operator>

        <value>2021-04-15T11:11:00.000</value>

      </filter>

    </filters>

  </ns2:GetBookings>

</S:Body>

</S:Envelope>