List Data Providers
This API method list all Data Providers that have implemented the Open Meal API specification and that has registered as a Data Provider. Use this method to get the Base URL for the Data Providers, which is required to call any other methods in the Open Meal API.
URL: | https://raw.githubusercontent.com/Orebrokommun/Open-Meal-Information/master/dataproviders.json |
HTTP Method: | GET |
Parameters: | None |
Formats: | JSON |
Response
The method returns a list of Data Providers, including name, contact information and Base URL. Data Providers are described with a data model inspired by the schema.org Organization.
Property | Type | Description | Required? |
---|---|---|---|
name | String | The name of the organisation | Yes |
lang | String | The 2-letter ISO 639 alpha-2 language code describing the language used in all Strings of this object. For example sv for Swedish. | Yes |
description | String | A brief description of the organisation | No |
address | Object | The address of the organisation | Yes |
address > streetAddress | String | The street address | No |
address > postalCode | String | The postal code | No |
address > addressLocality | String | The locality, for example the City | No |
address > addressRegion | String | The region, for example the State | No |
address > addressCountry | String | The 2-letter ISO 3166-1 aplha-2 country code, for example SE for Sweden | Yes |
url | String | The URL to the organisations web site | No |
String | A contact email address for the organisation | No | |
phone | String | A contact phone number for the organisation | No |
baseUrl | String | The Base URL is needed to call further API methods in order to get data from a Data Provider. | Yes |
Example
GET https://raw.githubusercontent.com/Orebrokommun/Open-Meal-Information/master/dataproviders.json
{
"data" : [
{
"name" : "Food Industries Inc.",
"lang" : "en",
"address" : {
"addressCountry" : "US"
},
"url" : "http://foodindustries.inc",
"email" : "openmeal@foodindustries.inc",
"telephone" : "+1 555 555 555",
"baseUrl" : "http://openmeal.foodindustries.inc"
},
...
]
}
Want to be included as a Data Provider?
This is open to all, read more about How to Implement the API.