list

Update a list item

Updates an item's name, status, notes, tags or parcels.

Sending parcel replaces a site's parcels. Use it to add parcels to an assemblage or remove them from one.

patch/v1/list/{list_id}/item/{item_id}

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/v1/list/{list_id}/item/{item_id}
  • Auth: HTTP bearer

Path parameters

list_idstring required

The list's id, lst_....

item_idstring required

The item's id, lsi_....

Request body

namestring nullable

The item's name. null clears it.

status'new' | 'reviewing' | 'pursuing' | 'passed' nullable

One of new, reviewing, pursuing or passed.

notesstring nullable

Notes. null clears them.

tagsstring[] nullable

The complete set of tags. Replaces the current set. [] or null clears them.

parcelstring[] nullable

A site's complete set of parcels. Replaces the current set.

filterobject nullable

The complete filter. Replaces the current one. null clears it.

Example request

{
  "parcel": [
    "prc_01h455vb4pex5vsknk084sn02q"
  ]
}

Response

The list item.

object'list_item' required

The object's type. Always list_item.

idstring required

Unique identifier for the object.

kind'site' | 'jurisdiction' | 'postal_code' | 'area' required

What the item is. One of site (one or more parcels), jurisdiction (a town or county), postal_code or area (a drawn polygon).

namestring nullable required

The item's name. Null when none was given.

status'new' | 'reviewing' | 'pursuing' | 'passed' required

Where the item stands. One of new, reviewing, pursuing or passed.

notesstring nullable required

Notes on the item. Null when there are none.

tagsstring[] required

Tags on the item, in the order they were added.

addressstring nullable required

A site's first parcel's address. Null unless kind is site.

acresnumber nullable required

A site's total lot size, in acres. Null unless kind is site.

postal_codestring nullable required

The ZIP code. Null unless kind is postal_code.

filterobject nullable required

GET /v1/parcel parameters that narrow a town, ZIP code or area. Null when there are none.

added_bystring nullable required

The email address of the member who added the item. Null when that member has left.

created_atstring date-time required

Time at which the object was created.

updated_atstring date-time required

Time at which the object was last updated.

hrefstring required

The object's path in the API.

Example response

{
  "id": "lsi_01h455vb4pex5vsknk084sn02q",
  "name": "Hwy 101 site",
  "tags": [
    "Owner contacted",
    "Needs survey"
  ],
  "parcel": [
    {
      "id": "prc_01h455vb4pex5vsknk084sn02q",
      "number": "0787517396",
      "address": "4516 PRINTER LN, RALEIGH, NC 27613",
      "acres": 0.26,
      "href": "/v1/parcel/prc_01h455vb4pex5vsknk084sn02q"
    }
  ],
  "address": "4516 PRINTER LN, RALEIGH, NC 27613",
  "acres": 3.09,
  "jurisdiction": {
    "id": "jur_01h455vb4pex5vsknk084sn02q",
    "name": "Wake",
    "type": "county",
    "fips": "37183",
    "href": "/v1/jurisdiction/jur_01h455vb4pex5vsknk084sn02q"
  },
  "postal_code": "27613",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -78.6999,
          35.849
        ],
        [
          -78.6993,
          35.849
        ],
        [
          -78.6993,
          35.8494
        ],
        [
          -78.6999,
          35.8494
        ],
        [
          -78.6999,
          35.849
        ]
      ]
    ]
  },
  "filter": {
    "min_acres": 10
  },
  "centroid": {
    "lat": 35.8492,
    "lon": -78.6996
  },
  "added_by": "ana@example.com",
  "href": "/v1/list/lst_01h455vb4pex5vsknk084sn02q/item/lsi_01h455vb4pex5vsknk084sn02q"
}

Changes

No recorded changes to this operation across all 1 revision of this API.