Add another property

maintenance.property.add

POST/api/v1/households/{household_id}/commands/maintenance.property.add

Command
Rigel runs it
Applies offline

Adds a property the household looks after, such as a cabin or a rental, with its root place "House". A household's first property is made automatically, so use this only for an additional one.

Parameters#

Add another property: parameters
Field	Description
`household_id`pathstringrequired	The household's ID.
`Idempotency-Key`headerstringoptional	The command's ID. Reuse it when retrying the same command.

Request body#

JSON, as application/json.

Add another property: request body fields
Field	Description
`name`stringrequired	What the household calls it: "Cabin", "Rental on Elm". at most 120 characters
`address`stringoptional	The postal address, as written. at most 500 characters

Response#

200 The command was applied.

Add another property: response fields
Field	Description
`result`objectrequired	What the command returned, such as the IDs it created.
`result.property_id`stringrequired	The new property.
`result.root_location_id`stringrequired	Its root place, "House".
`version`integerrequired	The household version after the command.

Errors#

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

Add another property: errors
Status	Code	When
`400`	`validation_failed`	A field is missing, misspelled or out of range. details.fields lists each problem.
`401`	`unauthenticated`	The request has no valid session.
`404`	`not_found`	The household doesn't exist, or you aren't a member of it.
`409`	`idempotency_key_reused`	The Idempotency-Key was already used for a different command.

Examples#

These are real. Each scenario is one of the command's test cases, run on a household when this site was built, and the response is what the API returned.

Adds a property with its root place

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.property.add' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "name": "Cabin",
  "address": "12 Lake Rd"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.property.add", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    name: "Cabin",
    address: "12 Lake Rd",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.property.add HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "name": "Cabin",
  "address": "12 Lake Rd"
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0HFH7XHZW81EEDFNH

{
  "result": {
    "property_id": "prp_01JC4N0000MBGE5RJ6Q7V6V6T8",
    "root_location_id": "mlc_01JC4N0000VGW1STJ6TGXRB7FY"
  },
  "version": 1
}

The first property of an empty household gets sort order 0 and no address

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.property.add' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "name": "Home"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.property.add", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    name: "Home",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.property.add HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "name": "Home"
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0MAT0JCNZARZ9GJV1

{
  "result": {
    "property_id": "prp_01JC4N0000MBGE5RJ6Q7V6V6T8",
    "root_location_id": "mlc_01JC4N0000VGW1STJ6TGXRB7FY"
  },
  "version": 1
}

For Rigel#

Rigel's tool for this command is maintenance_property_add. Rigel runs this on its own, then says what it did. The agent guide has the rest.