addressTableDelete

Description

Deletes an address table and optionally any associated files.

Remarks

addressTable must be one of the following.

• The ID of an address table. The ID of an address table is guaranteed to be unique.
• The name$ prefix plus the name of an address table. The name of an address table is not required to be unique. However, if you use the name$ prefix to reference an address table with a name that is not unique, there is an error. In this case, you must refer to the address table by its ID.
• The file$ prefix plus the name of a JSON file representing an address table, excluding extension. The file name must be lower case and have an extension of .json. The file must be in the addresstables/ folder.

Example for Deleting Address Table

Request

This request deletes only an address table.

{
  "addressTable": "7112661645"
}

Reply

id is the ID of the deleted address table. The ID is no longer valid.

{
  "id": "7112661645"
}

Example for Deleting Address Table and Files

Request

This request deletes an address table, associated database files and all other associated files.

{
  "addressTable": "7112661645",
  "deleteAllFiles": true
}

Reply

id is the ID of the deleted address table. The ID is no longer valid.

{
  "id": "7112661645"
}

Request Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "description":"Deletes an address table.",
  "type":"object",
  "required":[
    "addressTable"
  ],
  "properties":{
    "addressTable":{
      "title":"Address Table",
      "description":"Resource item identifying the address table.",
      "type":"string",
      "pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$"
    },
    "deleteDatabaseFiles":{
      "title":"Delete Database Files",
      "description":"Indicates whether or not to delete database files.",
      "default":false,
      "type":"boolean"
    },
    "deleteAllFiles":{
      "title":"Delete All Files",
      "description":"Indicates whether or not to delete all files.",
      "default":false,
      "type":"boolean"
    }
  },
  "additionalProperties":false
}

Reply Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"object",
  "required":[
    "id"
  ],
  "properties":{
    "id":{
      "title":"ID",
      "description":"Identifies the deleted address table.",
      "type":"string",
      "minLength":1
    }
  },
  "additionalProperties":false
}