POST public-api/locations/deletelocationsbycode

This method deletes existing locations by code. It requires the Delete Location permission and access to the Site where the Location is located. Note: This is a Post API to avoid limitations inherent to passing parameters on the URL.

Request Information

URI Parameters

None.

Body Parameters

Collection of LocationCodeWithSiteName

Name	Description	Type	Additional information
LocationCode	Simple string. Indicates the code for the location.	string	None.
SiteName	Simple string. Indicates the name of the site where the location resides.	string	None.

Request Formats

application/json

Sample:

[
  {
    "LocationCode": "Lobby",
    "SiteName": "New York Office"
  },
  {
    "LocationCode": "Supply Closet 1",
    "SiteName": "New York Office"
  },
  {
    "LocationCode": "Meeting Room 1",
    "SiteName": "New York Office"
  },
  {
    "LocationCode": "Office 101",
    "SiteName": "New York Office"
  }
]

Response Information

Resource Description

WaspResultOfResults

Name	Description	Type	Additional information
Data	Type specific result that always depends on the function called.	Results	None.
Messages	List of Messages. All APIs should return messages. If an API function returns an error you can find more information about the error or errors in this collection of messages.	Collection of WtResult	None.
BatchNumber	This is a global batch number generated by a mass group of transaction records to be returned to the consumer on each call to rolling transaction rules. This requests that each group of Move/Add/Remove transaction batches is tied together. In prior products (such as Mobile Asset Cloud), all are set to null and the only time when the batch number is generated is for multiple check-out transactions but the old is to generate for each responsible party.	integer	None.
HasError	True if an API function result has an error message in the results. If this is false, the function succeeded but other informative messages may be available.	boolean	None.
HasHttpError	True if an API function call could not be fully posted to the server or the results could not be fully returned.	boolean	None.
HasMessage	True if any message is available.	boolean	None.
HasSuccessWithMoreDataRemaining	True if the server sent part of the data and there is more data available. Use with paging APIs to fetch data one page at a time.	boolean	None.
TotalRecordsLongCount	This is the total number of records available in the database based on the query and filer conditions provided. It is possible that the value can change from call to call as users add and delete records so this should not be used to page through multiple recordsets of data. This is used, for example, to set relative scroll bar sizes. When paging through data using functions like the assetadvancedinfosearch, calculating TotalRecordsLongCount for every page full of data is an time-consuming operation. To avoid that extra calculation, and help prevent throttling, assign TotalRecordsLongCount to TotalCountFromPriorFetch in the AdvancedSearchParameters to skip recalculating this total page count and to page thru the records faster.	integer	None.

Response Formats

application/json

Sample:

{
  "Data": {
    "ResultList": [
      {
        "ResultCode": -41002,
        "Message": "Error retrieving location.",
        "HttpStatusCode": 422,
        "FieldName": "Lobby"
      },
      {
        "ResultCode": -41002,
        "Message": "Error retrieving location.",
        "HttpStatusCode": 422,
        "FieldName": "Supply Closet 1"
      },
      {
        "ResultCode": -41002,
        "Message": "Error retrieving location.",
        "HttpStatusCode": 422,
        "FieldName": "Meeting Room 1"
      },
      {
        "ResultCode": -41002,
        "Message": "Error retrieving location.",
        "HttpStatusCode": 422,
        "FieldName": "Office 101"
      }
    ],
    "SuccessfullResults": 0,
    "TotalResults": 4
  },
  "Messages": [
    {
      "ResultCode": -41002,
      "Message": "Error retrieving location.",
      "HttpStatusCode": 422,
      "FieldName": "Lobby"
    },
    {
      "ResultCode": -41002,
      "Message": "Error retrieving location.",
      "HttpStatusCode": 422,
      "FieldName": "Supply Closet 1"
    },
    {
      "ResultCode": -41002,
      "Message": "Error retrieving location.",
      "HttpStatusCode": 422,
      "FieldName": "Meeting Room 1"
    },
    {
      "ResultCode": -41002,
      "Message": "Error retrieving location.",
      "HttpStatusCode": 422,
      "FieldName": "Office 101"
    }
  ],
  "TotalRecordsLongCount": 4,
  "HasSuccessWithMoreDataRemaining": false,
  "HasError": true,
  "HasMessage": true,
  "HasHttpError": true
}