Delete parcels

URL:: https://<root>/<serviceName/ParcelFabricServer/deleteParcels
Methods:: POST
Required Capability:: ArcGIS Advanced Editing
Version Introduced:: 10.8

Description

The deleteParcels operation deletes parcels and updates the associated record polygon. Parcel polygons as well as the parcel lines and points will be deleted if they are not associated with any other parcels.

Learn more about deleting parcels

Request parameters

Parameter Details

Parameter	Details
`gdbVersion` (Required)	Introduced at 10.8. The name of the geodatabase version (the default is the DEFAULT version). Syntax Use dark colors for code blocksCopy `1 gdbVersion=<version>`
`sessionId` (Required)	Introduced at 10.8. The token (GUID) used to lock the version. If the calling client is editing a named version, the `sessionId` value is required. If the specified version is currently locked by another session, the request will fail if the `sessionId` value is not provided or does not match the `sessionId` value that holds the exclusive lock. If the client is editing the default version, the `sessionId` value is not required. Syntax Use dark colors for code blocksCopy `1 sessionId=<guid>`
`parcels` (Required)	Introduced at 10.8. The parcels that will be deleted. Syntax Use dark colors for code blocksCopy `1 parcels=[{"id":"<parcelguid>","layerId":"<layerID>"},{...}]`
`async` (Optional)	Introduced at 11.1. Specifies whether the request will be processed as an asynchronous job and a URL that points to a location displaying the status of the job will be returned. See the topic regarding asynchronous usage for more information. The default is `false`. Values: `true` \| `false` Syntax Use dark colors for code blocksCopy `1 async=true\|false`
`f`	Specifies the output format of the response. The default response format is `html`. Values: `html` \| `json`

gdbVersion

(Required)

Introduced at 10.8.

The name of the geodatabase version (the default is the DEFAULT version).

Syntax

Use dark colors for code blocksCopy
gdbVersion=<version>

sessionId

(Required)

Introduced at 10.8.

The token (GUID) used to lock the version. If the calling client is editing a named version, the sessionId value is required. If the specified version is currently locked by another session, the request will fail if the sessionId value is not provided or does not match the sessionId value that holds the exclusive lock. If the client is editing the default version, the sessionId value is not required.

Syntax

Use dark colors for code blocksCopy
sessionId=<guid>

parcels

(Required)

Introduced at 10.8.

The parcels that will be deleted.

Syntax

Use dark colors for code blocksCopy
parcels=[{"id":"<parcelguid>","layerId":"<layerID>"},{...}]

async

(Optional)

Introduced at 11.1.

Specifies whether the request will be processed as an asynchronous job and a URL that points to a location displaying the status of the job will be returned. See the topic regarding asynchronous usage for more information. The default is false.

Values: true | false

Syntax

Use dark colors for code blocksCopy
async=true|false

f

Specifies the output format of the response. The default response format is html.

Values: html | json

Example usage

This example shows the steps for deleting a parcel using the deleteParcels operation.

Start a service session on the version.

Request URL and parameters:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/rest/services/CountyFabric/VersionManagementServer/versions/E4DAED9D-C859-489B-9053-767A45F1D97C/startReading
f=json
sessionId={bba242fc-e671-4aa2-83d4-1c013347fa4f}

Start an edit session on the version.

Request URL and parameters:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/rest/services/CountyFabric/VersionManagementServer/versions/E4DAED9D-C859-489B-9053-767A45F1D97C/startEditing
f=json
sessionId={bba242fc-e671-4aa2-83d4-1c013347fa4f}

Delete a single parcel.

Request URL and parameters:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/rest/services/CountyFabric/ParcelFabricServer/deleteParcels
f=json
gdbVersion=admin.Version1
sessionId={bba242fc-e671-4aa2-83d4-1c013347fa4f}
parcels=[{"id":"{BECEBF25-9DFA-4FA3-9A8C-F6738E55DFC3}","layerId":"10"}]
async=false

If edits are complete, stop the edit session.
Stop and release the service session.

JSON Response syntax

The following response is returned when async is false:

Use dark colors for code blocksCopy
{
  "moment": <datetime>,
  "exceededTransferLimit": <true | false>,
  "serviceEdits": [  // only if transfer limit is not exceeded
    {
      "id": <layerID>,
      "editedFeatures": {
        "spatialReference": {<spatialreference>},
        "adds": [
          {
            "attributes": {...},
            "geometry": {...}
          }
        ]
      },
      {
        "id": <layerID>,
        "editedFeatures": {
          "spatialReference": {<spatialreference>},
          "deletes": [
            {
              "attributes": {...},
              "geometry": {...}
            }
          ]
        }
      }
    ]
    "success": <true | false>,
    "error": {  // only if success is false
      "extendedCode": <HRESULT>,
      "message": <error message>,
      "details": [<detail>
    }
  ]
}

The following response is returned when async is true :

Use dark colors for code blocksCopy
{
		"statusUrl": <url>
}