World

Patch World

Changed on

Owner only, with one exception: a co-builder may send time_range_current alone (moving the world's now). Writable: name, description, image_url, time_basic_unit, time_format_names, time_format_equivalents, time_range_min, time_range_max, time_range_current, length_unit, mass_unit, distance_unit (free-text unit labels, at most 64 characters, trimmed; "" clears), and owner_character (a Character id in this world, or null: the owner's "this Character is me", shown by GET /members and GET /me).

patch/api/v2/world

Request

  • Base URL: https://www.onlyworlds.com
  • URL: https://www.onlyworlds.com/api/v2/world
  • Auth: API key in header API-Key and API key in header API-Pin

Request body

namestring
descriptionstring
image_urlstring
time_format_namesstring[]

The names of the calendar's steps, e.g. ['Day', 'Week', 'Month', 'Year'].

time_format_equivalentsstring[]

How many time_basic_unit each step of time_format_names holds, in the same order, e.g. [1, 7, 30, 365] when the basic unit is Day.

time_basic_unitstring

The unit every element date and duration counts in (e.g. 'Year', 'Day'): a birth_date of 1200 is 1200 of these.

time_range_mininteger nullable

The earliest point of the world's timeline, in time_basic_unit.

time_range_maxinteger nullable

The latest point of the world's timeline, in time_basic_unit.

time_range_currentinteger nullable

The world's present moment, in time_basic_unit.

length_unitstring

Free-text label for the numbers counted in the world's length units; nothing converts.

mass_unitstring

Free-text label for the numbers counted in the world's mass units; nothing converts.

distance_unitstring

Free-text label for the numbers counted in the world's distance units; nothing converts.

owner_characterstring uuid nullable

The owner's "this Character is me": a Character id in this world, or null.

Response

The updated world.

idstring uuid required
namestring required
descriptionstring required
image_urlstring required
time_format_namesstring[] required

The names of the calendar's steps, e.g. ['Day', 'Week', 'Month', 'Year'].

time_basic_unitstring required

The unit every element date and duration counts in (e.g. 'Year', 'Day'): a birth_date of 1200 is 1200 of these.

time_range_mininteger nullable required

The earliest point of the world's timeline, in time_basic_unit.

time_range_maxinteger nullable required

The latest point of the world's timeline, in time_basic_unit.

time_range_currentinteger nullable required

The world's present moment, in time_basic_unit.

length_unitstring required

Free-text label for the numbers counted in the world's length units; nothing converts.

mass_unitstring required

Free-text label for the numbers counted in the world's mass units; nothing converts.

distance_unitstring required

Free-text label for the numbers counted in the world's distance units; nothing converts.

public_readboolean required

Whether the world's owner opened it to the public: where the public reader is on, anyone reads it with no key (?world=). Set by the owner on the world page; not writable here.

agent_narrator_ruleboolean required

Whether a Narrative written through an agent seat is narrated by that seat's own Character, as a guest's is. Set by the world's owner on the world page; not writable here.

owner_characterstring uuid nullable required

The owner's "this Character is me": a Character id in this world, or null.

created_atstring date-time nullable required
updated_atstring date-time nullable required

Moves when the world's own fields change, not on element writes.

Changes

  • 4dd5b1cd0687Revision changes
    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status