Interface RequestBuilderInternal

Overwrite the default endpoint

Example

new ODataRequest('Fractie')
   .endpoint('https://proxy.tweedekamer.nl/OData/v4/2.0')
Copy

Count the amount of results

Example

new ODataRequest('Fractie')
   .count(true)
Copy

Example

new ODataRequest('Fractie')
   .count(false)
Copy

Expand the request to include information from other entities

Example

new ODataRequest('Fractie')
    .expand('FractieZetel')
    .expand('Stemming', '$select=Soort')
Copy

Example

new ODataRequest('Fractie')
    .expand('FractieZetel')
    // Multiple functions can be applied to the same expansion
    // Using a semicolon (;) to separate them
    .expand('Stemming', "$top=1 ; $select=Soort")
Copy

Filter the results

Example

new ODataRequest('Fractie')
 .filter("Afkorting eq 'VVD'")
Copy

Example

new ODataRequest('Fractie')
 .filter("AantalZetels gt 10")
 .filter("AantalZetels lt 20")
Copy

The amount of metadata to return with the results

Example

new ODataRequest('Fractie')
 .format('none')
Copy

Example

new ODataRequest('Fractie')
 .format('minimal')
Copy

Example

new ODataRequest('Fractie')
 .format('full')
Copy

Order the results by a specific attribute

Example

new ODataRequest('Fractie')
  .orderby('NaamNL') // Direction defaults to asc
Copy

Example

new ODataRequest('Fractie')
  .orderby('NaamNL', 'asc')
Copy

Example

new ODataRequest('Fractie')
  .orderby('NaamNL', 'desc')
Copy

Select a specific attribute to return Will only show the attribute(s) selected for the entity

Example

new ODataRequest('Fractie')
  // You can select multiple attributes
  .select('NaamNL')
  .select('NaamEN')
Copy

Example

new ODataRequest('Fractie')
 .select('NaamNL')
Copy

Skip the first n results

Example

new ODataRequest('Fractie')
 .skip(1)
Copy

Example

new ODataRequest('Fractie')
  .skip(250)
Copy

Limit the amount of results returned

Example

new ODataRequest('Fractie')
  .top(1)
Copy

Example

new ODataRequest('Fractie')
 .top(250)
Copy

Throws

Error if $Top is already defined

Throws

Error if $Top is less than or equal to 0

Throws

Error if $Top is greater than 250

Use a custom query. Will overwrite all previously declared functions. And will directly use the given query. Functions declared after this function will also be ignored.

Throws

Error if the query does not start with a '$'

Remarks

• Will ignore all previously declared functions
• Will ignore all functions declared after this function

Example

new ODataRequest('Fractie')
 .custom('$select=Afkorting')
 // https://gegevensmagazijn.tweedekamer.nl/OData/v4/2.0/Fractie?$select=Afkorting
Copy

Example

new ODataRequest('Fractie')
   .custom('$select=Afkorting&$top=1')
 // https://gegevensmagazijn.tweedekamer.nl/OData/v4/2.0/Fractie?$select=Afkorting&$top=1
Copy

Select multiple attributes to return Will only show the attribute(s) selected for the entity

Example

new ODataRequest('Fractie')
 .selectMultiple(['NaamNL', 'NaamEN'])
 // You can also use the select function multiple times
 .selectMultiple(['DatumActief', 'DatumInactief'])
Copy

Example

new ODataRequest('Fractie')
 .selectMultiple(['NaamNL', 'NaamEN'])
 // You can also use the selectMultiple function in combination with the select function
 .select('DatumActief')
Copy

Select a list of attributes to return Will overwrite any previous select functions

Example

new ODataRequest('Fractie')
  .setSelect(['NaamNL', 'NaamEN'])
Copy

Given the current state of the RequestBuilderImpl, build the request url according to functions provided

Example

const construction = new ODataRequest('Fractie')
   .expand('FractieZetel')
   .top(1)

// Log the request url (build)
console.log(construction.build());
Copy

Given the current state of the RequestBuilderImpl, build the request url according to functions provided and then utilize cross-fetch to make the request

See

cross-fetch - Fetch API implementation

Remarks

Function flow: request -> build -> fetch

Example

new ODataRequest('Fractie')
   .expand('FractieZetel')
   .expand('Stemming', '$select=Soort')
   .top(1)
   .request()
   // Log the data
   .then(data => console.log(data))
   .catch(err => console.warn(err))
Copy

Example

const construction = new ODataRequest('Fractie')
    .expand('FractieZetel')
    .expand('Stemming', '$select=Soort')
    .top(1)

construction.request().then((data) => {
   // Log the data
    console.log(data);
}).catch((error) => {
    console.warn(error);
});
Copy

Unique function to gather information on a specific entity instead of the entire collection

Throws

If invalid query options are provided

Remarks

[!] Does not work with all other functions Query options $filter, $orderby, $count, $skip, and $top can be applied only on collections.

Example

new ODataRequest('Fractie')
  .findById('65129918-f256-4975-9da4-488da34d6695')
Copy