VIAWARN

British Columbia MOT

Fetching data from British Columbia MOT with Airbyte and Python.

Description

This Airbyte Connector uses the HTTP API provided by the British Columbia MOT in Python. With this connector, data is easily pulled from British Columbia MOT and loaded into the ViaWarn Postgres database, and are available in the ViaWarn app.

The connector is built on top of the Airbyte open-source platform, which provides a standardized way of integrating data sources and destinations. It is designed to be simple and easy to use. The required configuration is show in the the sections below. 

The pulled resources from the British Columbia 511 API are the following:

Requirements and Installation

Find the requirements and steps to create the connector in the Airbyte documentation.

Customized files

After creating the Airbyte connector template, modify the next files to retrieve data from British Columbia MOT .

spec.yaml

Location: source-viawarn-ca-bc-mot/spec.yaml
Access API: FREE
In this case, the connector password is specified in the spec file.
spec.yaml:
				
					documentationUrl: https://docsurl.com
connectionSpecification:
  $schema: http://json-schema.org/draft-07/schema#
  title: VIAWARN CAN BC MOT - Spec
  type: object
  properties:
    request_limit:
      type: integer
      description: Request limit as described here https://api.open511.gov.bc.ca/help (Default=50 (Leave empty), Maximum=500)

				
			

config.json

Location: secrets/config.json
This file is ignore by git.
config.json:
				
					{
    "request_limit":"[limit]"
}
				
			

configure_catalog.json

Location: integration_tests/configure_catalog.json
List of Streams that describes the data in the data store that a Source represents. It also declares the sync modes supported by each stream (full refresh or incremental).
configure_catalog.json:
				
					{
  "streams": [
    {
      "stream": {
        "name": "event",
        "json_schema": {},
        "supported_sync_modes": ["full_refresh"]
      },
      "sync_mode": "full_refresh",
      "destination_sync_mode": "overwrite"
    }
  ]
}
				
			

event.json

Location: source-viawarn-ca-bc-mot/schemas/event.json
Declare the stream schema by adding a json file describing the output from that stream.
Streams name: event

source.py

Location: source-viawarn-ca-bc-mot/source.py

class ViawarnCaBcMotStream()

Create a stream to represent the data that will be pull from the API. It contains all the common API functionalities:
  •  url_base

This field is the common part of the URL for all streams.

String

  • __init__()

This is a constructor method used to initialize the class. It uses the ‘config’ object to define the ‘request_limit” attribute.

return config[]

  • next_page_token()

Retrieve ‘offset’ parameter from the response if the ‘pagination’ key exists, otherwise return None.

return dictionary

  • request_params()

The API requires two parameters: the ‘request_limit’ and the ‘offset’ in which the data will be passed.

return a dictionary

  • parse_response()

It is a placeholder to store the request.response object and constructs the appropriate mapping object for each parsed element by each Stream class.

yields an empty dictionary.

class Event()

This method extends the ViawarnCaBcMotStream() method to specified unique behavior for this stream.
  • primary_key

Unique field required in the stream associate to each output record.

String

  • path()

subdomain to be passed into the URL.

return a string

  • parse_response()

Definition of how a response is parsed.

Set a definition to: primary key and ewkt fields.

return an iterable containing each record in the response.

class SourceViawarnCaBcMot()

  • check_connection()

Set up a test to verify the connection between the connector and the API. This test should return two variables: the first one is a boolean that indicates the status of the connection, while the second one shows a log message if the connection fails.

return True, None

  • streams()
Set up the stream in the source that will be parsed.
return List of streams

The displayed occurrences are limited. To access the complete dataset, please join us in the ViaWarn app.

Resources

support@viawarn.com