Law

Hide a law

Changed on

The world's owner key, or a co-builder's (a person's or a seat's), with its PIN. Marks the element hidden; hiding a hidden element again changes nothing. No Idempotency-Key: the call is idempotent. The element's body and its change_seq do not change. A hidden element is seen only by the world's owner, its co-builders and the member who created it. To every other key it is as if it did not exist: a GET of it is 404, lists, search and counts leave it out, links to it are left out of the elements that carry them (those elements do not change), and a write naming its id answers as a missing id does. A key the owner minted (no member) reads as the owner and sees hidden elements. On /changes, a hide gives each contributor who loses the element (person or seat, never the member who made it) one delete row with reason hidden, at the change_seq the hide took; a guest gets no row, and its feed resets (409 resync_required) if it saw the element. An unhide resets every contributor and guest that regains it. A hidden Character is null on the roster (GET /members, GET /me, the world's owner_character) and can never be the Character a seat or a player plays (422 character_hidden). The hidden mark answers only where the server has it switched on; elsewhere every hidden route is a 404.

put/api/v2/law/{id}/hidden

Request

  • Base URL: https://www.onlyworlds.com
  • URL: https://www.onlyworlds.com/api/v2/law/{id}/hidden
  • 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).

Request body

fieldsstring[]

Reserved for hiding single fields, which is not built yet: leave it out or send []. A non-empty list is a 422.

Response

Hidden.

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