Law

Create or replace a law by id

Changed on
put/api/v2/law/{id}

Request

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

Path parameters

idstring uuid required

The law's id (a malformed id is a 422).

Headers

X-OW-Agentstring

Send it (any non-empty value) when an agent makes this write: the change is recorded with changed_via declared (a delete's tombstone with deleted_via). An agent seat's key and MCP are recorded as agent-made without it. The value is never stored.

Request body

idstring uuid

POST: optional client-minted id (any RFC 4122 UUID; the server mints a UUIDv7 otherwise). PUT/PATCH: ignored, the path id wins.

namestring nullable required

Name of the element. null stores ''.

descriptionstring nullable

Any kind of details about the element. null stores ''.

supertypestring nullable

The top level category to which the element belongs. null stores ''.

subtypestring nullable

The sub level category through which the element is further classified. null stores ''.

image_urlstring nullable

URL to an image representing the element. null stores ''.

declarationstring nullable

The formal wording, expression, or decree of the law. null stores ''.

purposestring nullable

The intent, motivation, or justification for the law's creation. null stores ''.

dateinteger nullable

Date the law was formally established, in world TIME units.

parent_lawstring uuid nullable

A law that this law derives from, modifies, or enhances. Links a Law: an existing one in this world.

authorstring uuid nullable

The institution that created or issued the law. Links an Institution: an existing one in this world.

penaltiesstring[] nullable

Consequences intended to be applied when the law is contravened. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

locationsstring[] nullable

Locations where the law is supported or enforced. Links Location elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

zonesstring[] nullable

Zones where the law is supported or enforced. Links Zone elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

prohibitionsstring[] nullable

Things that the law explicitly or effectively forbids. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

adjudicatorsstring[] nullable

Titles responsible for interpreting or ruling on the law's application and jurisdiction. Links Title elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

enforcersstring[] nullable

Titles responsible for enforcing or imposing the law. Links Title elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

worldunknown
created_byunknown
changed_byunknown
changed_viaunknown

Response

Replaced: the full element.

type'law' required
idstring uuid required
namestring required

Name of the element.

descriptionstring required

Any kind of details about the element.

supertypestring required

The top level category to which the element belongs.

subtypestring required

The sub level category through which the element is further classified.

image_urlstring required

URL to an image representing the element.

declarationstring required

The formal wording, expression, or decree of the law.

purposestring required

The intent, motivation, or justification for the law's creation.

dateinteger nullable required

Date the law was formally established, in world TIME units.

parent_lawstring uuid nullable required

A law that this law derives from, modifies, or enhances. A Law's id.

authorstring uuid nullable required

The institution that created or issued the law. An Institution's id.

penaltiesstring[] required

Consequences intended to be applied when the law is contravened. Construct ids.

locationsstring[] required

Locations where the law is supported or enforced. Location ids.

zonesstring[] required

Zones where the law is supported or enforced. Zone ids.

prohibitionsstring[] required

Things that the law explicitly or effectively forbids. Construct ids.

adjudicatorsstring[] required

Titles responsible for interpreting or ruling on the law's application and jurisdiction. Title ids.

enforcersstring[] required

Titles responsible for enforcing or imposing the law. Title ids.

created_atstring date-time required
updated_atstring date-time required
change_seqinteger required

The world change sequence at this element's last write.

created_bystring uuid nullable required

The world membership that created this element, or null when the world's owner did.

changed_bystring uuid nullable required

The world membership that last changed this element, or null when the world's owner (or the server) did, or no write has touched it since doors were recorded.

changed_via'seat' | 'mcp' | 'declared' | 'api' | 'v1' | 'sync' | 'server' | 'null' nullable required

The door of the last change: seat (an agent seat), mcp (the MCP server), declared (the request sent an X-OW-Agent header), api, v1, sync (the mobile app's sync) or server (the server, on its own behalf). The first three mean an agent made it. Null: no write since doors were recorded.

known_oftrue

Present, and true, only on an element this reader knows of but does not see whole: a guest or player reaches it only because its own Character's sheet links to it (one step out). Such a row keeps id, type, name, description, supertype, subtype, image_url, created_at, updated_at and change_seq; every other field reads as unset (text "", numbers and single links null, multi links [], created_by, changed_by and changed_via null, no extension fields), its files are 404, and search matches only its name and description. Absent: the element is whole. Any other grant (it names the reader's Character, the reader knows it, it is on the roster, the reader made it) makes it whole; a hidden element is never even a stub.

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 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

    • 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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status