Skip to content
Developers
Get an API token

Rename or share an area set

Change an area set's name or visibility (at least one) and get back its record and new ETag.

Rename or share an area set

PATCH/area-sets/{id}

Change an area set's name or visibility (at least one) and get back its record and new ETag. Only its creator, signed in, can make it private.

Send a Novi API token as a bearer token on every request. Authentication
Conflicts

A stale If-Match is a 409 with the current ETag in details.etag, as is, with or without it, a change made while the request ran.

Errors

A private set answers only its signed-in creator; another user's private set, a deleted one, another tenant's or an unknown id is 404. A server without a state store answers 409 "Area sets need a state store; this server keeps plans in memory".

Parameters

Path parameters

Header parameters

  • If-MatchstringOptional

    The set's ETag, including quotes.

Request bodyRequired

application/json

The fields to change.

  • namestringOptional

    1 to 100 characters

    The new name.

  • visibilitystringOptional

    private (its signed-in creator only) or tenant.

    "private""tenant"

Responses

200 OK

The updated record and its ETag.

  • idstringRequired

    Format uuid

    Its id.

  • namestringRequired

    Its name, 1 to 100 characters.

  • countintegerRequired

    ≥ 1

    Areas in it.

  • acresnumberRequired

    Its areas' acres added up, rounded to 0.01.

  • bboxarray of numbersRequired

    4 items

    West, south, east and north of its areas' outer rings, WGS 84.

  • crsobjectRequired

    The coordinate system the file was read in, and how sure that is.

    ShowHide 6 child fields
    • codestringRequired

      The system read: an EPSG code, as EPSG:2277, or the .prj's name when no supported system matches it (it was read through the .prj itself).

    • namestringRequired

      Its name, as NAD83 / Texas Central (ftUS).

    • sourcestringRequired

      request: the request's crs; file: the .prj, the GeoJSON (crs member, or degrees per RFC 7946) or a KML (WGS 84); detected: the first supported system that puts the areas on the dataset.

      "request""file""detected"
    • datum_shiftstring or nullRequired

      nadcon_conus: NAD27, shifted to NAD83 with NOAA's NADCON conus grid; else null.

      "nadcon_conus"
    • max_offset_ftintegerRequired

      ≥ 0

      The largest alternative's offset_ft, or 0: how far the areas could be off if the file is in another system that also fits.

    • alternativesarray of objectsRequired

      With detection: the other systems that fit, in preference order, under 1 ft apart listed once.

      ShowHide 3 child fields in each item
      • codestring or nullRequired

        Its EPSG code; null for an international-foot variant, which crs can't name.

      • namestringRequired

        Its name.

      • offset_ftintegerRequired

        ≥ 1

        The farthest a sampled vertex lands from where it is read now, ft.

  • name_fieldstring or nullRequired

    The field the areas' names came from, or null.

  • fileobject or nullRequired

    The uploaded file; null from a JSON body.

    ShowHide 3 child fields
    • namestring or nullRequired

      The file part's name, or null without one.

    • bytesintegerRequired

      ≥ 0

      Its size.

    • sha256stringRequired

      Its SHA-256, hex.

  • visibilitystringRequired

    private: its signed-in creator only; tenant: every user of the tenant.

    "private""tenant"
  • created_bystring or nullRequired

    Its signed-in creator's email, or null.

  • created_atstringRequired

    Format date-time

    When it was kept.

  • updated_atstringRequired

    Format date-time

    When it last changed.

  • name_fieldsarray of stringsOptional

    Only for a set made with name_fields: those fields as the file spells them, in the order sent; name_field is the first.

  • name_separatorstringOptional

    Only for a set made with name_fields: what joined their values.

Errors

StatusWhen
404

No such well, grid, plan or route.

409

A stale If-Match, or a change made while the request ran (details.etag is the current one). A server without a state store answers 409 "Area sets need a state store; this server keeps plans in memory".

413

The request body is over 10 MB.

Shared errors400401403500What they mean