Entries/Places

Update an entry

Changed on

The edited entry must include the next version of this entry in the version field, where next version = current version + 1.

put/entries/{id}

Request

  • Base URL
    https://api.ofdb.io/v0
  • URL
    https://api.ofdb.io/v0/entries/{id}
  • Auth
    • HTTP bearer
    • or API key in cookie ofdb-captcha
    • or HTTP bearer
    • or API key in cookie ofdb-user-email

Path parameters

idstring required

Identifier of a resource

Example:7cee99c287094a94acbdcf29ffff2e85

Request body

titlestring required
descriptionstring required
latnumber double required

Geographic latitude (in degrees)

lngnumber double required

Geographic longitude (in degrees)

streetstring
zipstring
citystring
countrystring
statestring
contact_namestring

The full name of a person.

emailstring

An e-mail address.

telephonestring
homepagestring
opening_hoursstring

The opening hours in OpenStreetMap format.

Specification: https://wiki.openstreetmap.org/wiki/Key:opening_hours

Reference implementations: https://github.com/opening-hours/

Generator tool: https://projets.pavie.info/yohours/

The service trims leading/trailing whitespaces and stores values as is. Values are currently not validated against the OSM format syntax!

founded_onstring date

The date on which an organization, initiative, or company has been founded or established.

categoriesstring[]
tagsTag[]
image_urlstring
image_link_urlstring
versioninteger

Example request

{
  "lat": 37.2,
  "lng": 120.7,
  "contact_name": "John Smith",
  "email": "john.smith@example.com",
  "telephone": "001 123456789",
  "homepage": "https://www.slowtec.de/",
  "opening_hours": "24/7",
  "founded_on": "1945-10-24",
  "tags": [
    "organic",
    "non-profit"
  ],
  "image_url": "https://www.slowtec.de/",
  "image_link_url": "https://www.slowtec.de/",
  "links": [
    {
      "url": "https://www.slowtec.de/"
    }
  ]
}

Response

Successful response

Changes

  • fdad7ffe4059Revision changes
    • info

      the request property //// became optional

    • info

      the request property //// became optional

  • 36db91c22909Revision changes
    • info

      the request property //// became optional