Adding an MDS Agency ID
MDS uses Agency IDs in the program Policy Requirements endpoint to reference agencies in a unique, consistent, and comprehensive way.
If you are using the Requirements endpoint, agencies must add a unique agency_id to our agencies.csv file.
You can do this by opening a Pull Request or an Issue here on GitHub.
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:
agency_country_iso_code,agency_state,agency_city,agency_name,agency_id,department_url,requirement_url
Example:
US,Atlantis,SimCity,Myst Transpo Agency,2411d395-04f2-47c9-ab66-d09e9e3c3251,https://www.simcity.gov/transporation,https://
Fields:
-
agency_country_iso_code- Two letter ISO country code where your agency is located. -
agency_state- Geographic abbreviation or name of the state where your agency is located. -
agency_city- Geographic name of the city where your agency is located. -
agency_name- Full name of your governmental city/agency. -
agency_id- A random UUID version 4. There are lots of way to generate a unique UUID, like using this website. -
department_url- URL to the home page of your agency's department. -
requirement_url- Full https:// URL where your Policy Requirements endpoint is located.
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.
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.
You can start start referring to and using your ID as soon as it's live in the dev branch. In the next MDS release, the OMF will push it to the main branch as well.
If you need help, please contact the OMF Staff.
