Adding a CDS Data Source Operator ID - openmobilityfoundation/curb-data-specification GitHub Wiki

How Do I Get a CDS Data Source Operator ID?

CDS uses Data Source Operator IDs to designate specific operators of data sources in a unique, consistent, and comprehensive way across curb areas and nearby jurisdictions. These IDs are used to identify companies operating and sending data through data sources like fleet vehicles, sensors, etc.

A city or agency may request an ID for policy, management, or operational purposes. Work with them to determine if an existing ID applies to you, or if multiple IDs are needed for different departments or operational units within your company.

If you are a new data source operator and need a CDS ID you must add a unique data_source_operator_id to our data_source_operators.csv file.

You can do this by opening a Pull Request or an Issue here on GitHub.

Pull Request

If you are comfortable with GitHub, you can create a pull request to add a new row of information needed for your company, in CSV format:

data_source_operator_name,data_source_operator_id,url

Example:

Company Name,766ffe82-c12c-4023-a424-0cfc2b620832,https://www.CompanyWebsite.com

Fields:

  • data_source_operator_name - Short name of your company with proper capitalization. You may need one ID for your company, and one for each operational division or brand within the same company.

  • data_source_operator_id - A random UUID version 4. There are lots of ways to generate a unique UUID, like using this website.

  • url - URL to the home page or division of your company.

Important

If it's your first time contributing, you must sign the Contributor License Agreement. Click the CLA assistant check button on your Pull Request page and follow the instructions. We cannot merge your changes until this is complete.

Once it looks good on our end, we will merge it to the dev branch so it's live and you can start referring to and using it. This may take a few working days.

Issue

Alternatively and possibly easier, you can open an Issue here and describe what you'd like to have added, and then the OMF Staff can create a pull request and update it for you.

Once it looks good on your end, we will merge it to the dev branch so it's live and you can start referring to and using it.

It may take a few days for us to create a branch and setup a pull request. If you would like to expedite the process, please create a pull request instead of an issue.

Using Your ID

You can start start referring to and using your ID as soon as it's live in the dev branch. In the next CDS release, the OMF will push it to the main (approved) branch as well.

Help

If you need help, please contact the OMF Staff.