Institution

Update part of an institution

Changed on
patch/api/v2/institution/{id}

Request

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

Path parameters

idstring uuid required

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

Headers

If-Matchstring

Apply only if the element's change_seq is still this number (quoted or bare; * or no header means unconditional). When the element has moved, 412 precondition_failed with the live element as current beside the envelope; nothing is written and nothing is merged.

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

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

doctrinestring nullable

Core belief, mission, or purpose that drives the institution. null stores ''.

statusstring nullable

Current political, cultural, or functional standing of the institution in the world. null stores ''.

founding_dateinteger nullable

Date when the institution was established, in the world's TIME format.

parent_institutionstring uuid nullable

Institution that governs, embodies, or originated this one. Links an Institution: an existing one in this world.

zonesstring[] nullable

Areas the institution controls or claims authority over. Links Zone elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

objectsstring[] nullable

Significant objects owned or tied to the institution's operations, holdings, or identity. Links Object elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

creaturesstring[] nullable

Creatures under the institution's protection, use, or symbolic control. Links Creature elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

alliesstring[] nullable

Institutions this one actively cooperates or aligns with. Links Institution elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

adversariesstring[] nullable

Institutions this one opposes, competes with, or is in conflict with. Links Institution elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

constructsstring[] nullable

Conceptual, procedural, or structural systems created or maintained by the institution. Links Construct 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

Updated: the full element.

type'institution' 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.

doctrinestring required

Core belief, mission, or purpose that drives the institution.

statusstring required

Current political, cultural, or functional standing of the institution in the world.

founding_dateinteger nullable required

Date when the institution was established, in the world's TIME format.

parent_institutionstring uuid nullable required

Institution that governs, embodies, or originated this one. An Institution's id.

zonesstring[] required

Areas the institution controls or claims authority over. Zone ids.

objectsstring[] required

Significant objects owned or tied to the institution's operations, holdings, or identity. Object ids.

creaturesstring[] required

Creatures under the institution's protection, use, or symbolic control. Creature ids.

alliesstring[] required

Institutions this one actively cooperates or aligns with. Institution ids.

adversariesstring[] required

Institutions this one opposes, competes with, or is in conflict with. Institution ids.

constructsstring[] required

Conceptual, procedural, or structural systems created or maintained by the institution. Construct 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, and its type's public fields (none for an institution); 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 what it keeps. 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, whatever its public fields. Read-only: a write carrying known_of is refused (known_of_not_writable).

Changes

  • 78df39c4c62eRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

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

    • 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